From 39e4c28e8ccbd468ebab64d1339297cc20139565 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Mon, 8 Dec 2025 22:21:15 +0000 Subject: [PATCH 1/5] fix(cli, typescript): Fix package.json metadata loss during local generation When using non-self-hosted GitHub configuration with npm output, the package.json metadata (name, version, repository, private) was being lost during local TypeScript SDK generation. The issue was that getPublishConfig returned undefined for non-self-hosted github configs, causing the generator to fall back to 'test-package' as the package name. This fix: 1. Updates getPublishConfig to create a filesystem publishConfig with the publish target for non-self-hosted github configs with output info 2. Updates the TypeScript generator to fall back to publishConfig when the output mode doesn't provide npm package info Co-Authored-By: Niels Swimberghe <3382717+Swimburger@users.noreply.github.com> --- generators/typescript/sdk/versions.yml | 8 +++++ .../src/AbstractGeneratorCli.ts | 29 ++++++++++++++----- packages/cli/cli/versions.yml | 8 +++++ .../src/runLocalGenerationForWorkspace.ts | 14 +++++++++ 4 files changed, 51 insertions(+), 8 deletions(-) diff --git a/generators/typescript/sdk/versions.yml b/generators/typescript/sdk/versions.yml index e0de164501b7..a71269c5bca2 100644 --- a/generators/typescript/sdk/versions.yml +++ b/generators/typescript/sdk/versions.yml @@ -1,4 +1,12 @@ # yaml-language-server: $schema=../../../fern-versions-yml.schema.json +- version: 3.37.2 + changelogEntry: + - summary: | + Fix package.json metadata (name, version, repository, private) being lost during local generation when using non-self-hosted GitHub configuration with npm output. The generator now falls back to publishConfig when the output mode doesn't provide npm package info. + type: fix + createdAt: "2025-12-08" + irVersion: 62 + - version: 3.37.1 changelogEntry: - summary: | diff --git a/generators/typescript/utils/abstract-generator-cli/src/AbstractGeneratorCli.ts b/generators/typescript/utils/abstract-generator-cli/src/AbstractGeneratorCli.ts index f6a6abdf4e0c..9111905a2356 100644 --- a/generators/typescript/utils/abstract-generator-cli/src/AbstractGeneratorCli.ts +++ b/generators/typescript/utils/abstract-generator-cli/src/AbstractGeneratorCli.ts @@ -84,14 +84,17 @@ export abstract class AbstractGeneratorCli { parse: serialization.IntermediateRepresentation.parse }); - const npmPackage = ir.selfHosted - ? constructNpmPackageFromArgs( - npmPackageInfoFromPublishConfig(config, ir.publishConfig, this.isPackagePrivate(customConfig)) - ) - : constructNpmPackage({ - generatorConfig: config, - isPackagePrivate: this.isPackagePrivate(customConfig) - }); + // First try to construct npmPackage from the output mode (github/publish modes) + // If that returns undefined (e.g., downloadFiles mode), fall back to publishConfig + const npmPackageFromOutputMode = constructNpmPackage({ + generatorConfig: config, + isPackagePrivate: this.isPackagePrivate(customConfig) + }); + const npmPackage = + npmPackageFromOutputMode ?? + constructNpmPackageFromArgs( + npmPackageInfoFromPublishConfig(config, ir.publishConfig, this.isPackagePrivate(customConfig)) + ); await generatorNotificationService.sendUpdate( FernGeneratorExec.GeneratorUpdate.initV2({ @@ -319,6 +322,16 @@ function npmPackageInfoFromPublishConfig( licenseConfig: config.license }; } + } else if (publishConfig?.type === "filesystem") { + if (publishConfig.publishTarget?.type === "npm") { + args = { + packageName: publishConfig.publishTarget.packageName, + version: publishConfig.publishTarget.version, + repoUrl: undefined, + publishInfo: undefined, + licenseConfig: config.license + }; + } } return { ...args, diff --git a/packages/cli/cli/versions.yml b/packages/cli/cli/versions.yml index f744a2969ed0..ec87fb00f938 100644 --- a/packages/cli/cli/versions.yml +++ b/packages/cli/cli/versions.yml @@ -1,4 +1,12 @@ # yaml-language-server: $schema=../../../fern-versions-yml.schema.json +- changelogEntry: + - summary: | + Fix package.json metadata (name, version, repository, private) being lost during local TypeScript SDK generation when using non-self-hosted GitHub configuration with npm output. + type: fix + irVersion: 63 + createdAt: "2025-12-08" + version: 3.4.5 + - changelogEntry: - summary: | Fallback to variant type for display name if title and mapping are not present. diff --git a/packages/cli/generation/local-generation/local-workspace-runner/src/runLocalGenerationForWorkspace.ts b/packages/cli/generation/local-generation/local-workspace-runner/src/runLocalGenerationForWorkspace.ts index 44f5e5d4694b..fd81ae7d35b7 100644 --- a/packages/cli/generation/local-generation/local-workspace-runner/src/runLocalGenerationForWorkspace.ts +++ b/packages/cli/generation/local-generation/local-workspace-runner/src/runLocalGenerationForWorkspace.ts @@ -552,6 +552,20 @@ function getPublishConfig({ }); } + // For non-self-hosted github configs with output info, create a filesystem publishConfig + // with the publish target so that package.json metadata is preserved + if (generatorInvocation.raw?.github != null && generatorInvocation.raw?.output != null) { + const publishTarget = getPublishTarget({ + outputSchema: generatorInvocation.raw.output, + version, + packageName + }); + return FernIr.PublishingConfig.filesystem({ + generateFullProject: org?.selfHostedSdKs ?? false, + publishTarget + }); + } + return generatorInvocation.outputMode._visit({ downloadFiles: () => { return FernIr.PublishingConfig.filesystem({ From 6f0113776fd15465235b0ff4b8ca10d6c6784559 Mon Sep 17 00:00:00 2001 From: Niels Swimberghe <3382717+Swimburger@users.noreply.github.com> Date: Mon, 8 Dec 2025 18:41:36 -0500 Subject: [PATCH 2/5] fix: update generator-cli-sdk version and improve package.json generation reliability --- generators/base/package.json | 2 +- .../src/utils/constructNpmPackage.ts | 2 +- generators/typescript/sdk/cli/Dockerfile | 2 +- .../typescript/sdk/generator/package.json | 2 +- generators/typescript/sdk/versions.yml | 2 +- .../src/AbstractGeneratorCli.ts | 69 +++++++++++-------- 6 files changed, 44 insertions(+), 35 deletions(-) diff --git a/generators/base/package.json b/generators/base/package.json index 4bf31369a307..9b3cd1db2037 100644 --- a/generators/base/package.json +++ b/generators/base/package.json @@ -37,7 +37,7 @@ "@fern-api/fs-utils": "workspace:*", "@fern-api/logger": "workspace:*", "@fern-api/logging-execa": "workspace:*", - "@fern-fern/generator-cli-sdk": "^0.1.5", + "@fern-fern/generator-cli-sdk": "^0.5.0", "js-yaml": "^4.1.1", "lodash-es": "^4.17.21", "tmp-promise": "^3.0.3" diff --git a/generators/typescript-v2/browser-compatible-base/src/utils/constructNpmPackage.ts b/generators/typescript-v2/browser-compatible-base/src/utils/constructNpmPackage.ts index af273281f038..5314cec16398 100644 --- a/generators/typescript-v2/browser-compatible-base/src/utils/constructNpmPackage.ts +++ b/generators/typescript-v2/browser-compatible-base/src/utils/constructNpmPackage.ts @@ -76,7 +76,7 @@ export function constructNpmPackage({ } } -function getRepoUrlFromUrl(repoUrl: string | undefined): string | undefined { +export function getRepoUrlFromUrl(repoUrl: string | undefined): string | undefined { if (repoUrl == null) { return undefined; } diff --git a/generators/typescript/sdk/cli/Dockerfile b/generators/typescript/sdk/cli/Dockerfile index 2614be491660..127fbc419a87 100644 --- a/generators/typescript/sdk/cli/Dockerfile +++ b/generators/typescript/sdk/cli/Dockerfile @@ -15,7 +15,7 @@ RUN pnpm install -g oxfmt@0.9.0 RUN pnpm install -g @biomejs/biome@2.3.1 RUN pnpm install -g oxlint@1.25.0 RUN pnpm install -g oxlint-tsgolint@0.4.0 -RUN pnpm install -f -g @fern-api/generator-cli@0.2.0 +RUN pnpm install -f -g @fern-api/generator-cli@0.5.0 WORKDIR /tmp/cache-warm diff --git a/generators/typescript/sdk/generator/package.json b/generators/typescript/sdk/generator/package.json index 092099058fd8..155ffb6f38c4 100644 --- a/generators/typescript/sdk/generator/package.json +++ b/generators/typescript/sdk/generator/package.json @@ -36,7 +36,7 @@ "@fern-api/fs-utils": "workspace:*", "@fern-api/logger": "workspace:*", "@fern-api/typescript-ast": "workspace:*", - "@fern-fern/generator-cli-sdk": "^0.1.5", + "@fern-fern/generator-cli-sdk": "^0.5.0", "@fern-fern/generator-exec-sdk": "^0.0.1167", "@fern-fern/ir-sdk": "^61.7.0", "@fern-typescript/commons": "workspace:*", diff --git a/generators/typescript/sdk/versions.yml b/generators/typescript/sdk/versions.yml index a71269c5bca2..8491a3acd8ec 100644 --- a/generators/typescript/sdk/versions.yml +++ b/generators/typescript/sdk/versions.yml @@ -2,7 +2,7 @@ - version: 3.37.2 changelogEntry: - summary: | - Fix package.json metadata (name, version, repository, private) being lost during local generation when using non-self-hosted GitHub configuration with npm output. The generator now falls back to publishConfig when the output mode doesn't provide npm package info. + Make package.json generation more reliable. type: fix createdAt: "2025-12-08" irVersion: 62 diff --git a/generators/typescript/utils/abstract-generator-cli/src/AbstractGeneratorCli.ts b/generators/typescript/utils/abstract-generator-cli/src/AbstractGeneratorCli.ts index 9111905a2356..693f817fd572 100644 --- a/generators/typescript/utils/abstract-generator-cli/src/AbstractGeneratorCli.ts +++ b/generators/typescript/utils/abstract-generator-cli/src/AbstractGeneratorCli.ts @@ -17,6 +17,7 @@ import { constructNpmPackage, constructNpmPackageArgs, constructNpmPackageFromArgs, + getRepoUrlFromUrl, NpmPackage, PersistedTypescriptProject } from "@fern-typescript/commons"; @@ -84,17 +85,18 @@ export abstract class AbstractGeneratorCli { parse: serialization.IntermediateRepresentation.parse }); - // First try to construct npmPackage from the output mode (github/publish modes) - // If that returns undefined (e.g., downloadFiles mode), fall back to publishConfig - const npmPackageFromOutputMode = constructNpmPackage({ - generatorConfig: config, - isPackagePrivate: this.isPackagePrivate(customConfig) - }); - const npmPackage = - npmPackageFromOutputMode ?? - constructNpmPackageFromArgs( - npmPackageInfoFromPublishConfig(config, ir.publishConfig, this.isPackagePrivate(customConfig)) - ); + const npmPackage = ir.selfHosted + ? (constructNpmPackageFromArgs( + npmPackageInfoFromPublishConfig(config, ir.publishConfig, this.isPackagePrivate(customConfig)) + ) ?? + constructNpmPackage({ + generatorConfig: config, + isPackagePrivate: this.isPackagePrivate(customConfig) + })) + : constructNpmPackage({ + generatorConfig: config, + isPackagePrivate: this.isPackagePrivate(customConfig) + }); await generatorNotificationService.sendUpdate( FernGeneratorExec.GeneratorUpdate.initV2({ @@ -308,26 +310,13 @@ function npmPackageInfoFromPublishConfig( isPackagePrivate: boolean ): constructNpmPackageArgs { let args = {}; - if (publishConfig?.type === "github") { - if (publishConfig.target?.type === "npm") { - const repoUrl = - publishConfig.repo != null && publishConfig.owner != null - ? `https://github.com/${publishConfig.owner}/${publishConfig.repo}` - : publishConfig.uri; + if (publishConfig?.type === "github" || publishConfig?.type === "direct" || publishConfig?.type === "filesystem") { + const target = publishConfig?.type === "filesystem" ? publishConfig.publishTarget : publishConfig.target; + if (target?.type === "npm") { args = { - packageName: publishConfig.target.packageName, - version: publishConfig.target.version, - repoUrl, - publishInfo: undefined, - licenseConfig: config.license - }; - } - } else if (publishConfig?.type === "filesystem") { - if (publishConfig.publishTarget?.type === "npm") { - args = { - packageName: publishConfig.publishTarget.packageName, - version: publishConfig.publishTarget.version, - repoUrl: undefined, + packageName: target.packageName, + version: target.version, + repoUrl: getRepoUrl(publishConfig), publishInfo: undefined, licenseConfig: config.license }; @@ -339,6 +328,26 @@ function npmPackageInfoFromPublishConfig( }; } +function getRepoUrl( + publishConfig: FernIr.PublishingConfig.Github | FernIr.PublishingConfig.Direct | FernIr.PublishingConfig.Filesystem +): string | undefined { + const url = publishConfig._visit({ + github: (value) => { + if (value.owner != null && value.repo != null) { + return `https://github.com/${value.owner}/${value.repo}`; + } + return value.uri; + }, + direct: () => undefined, + filesystem: () => undefined, + _other: () => undefined + }); + if (!url) { + return undefined; + } + return getRepoUrlFromUrl(url); +} + class GeneratorContextImpl implements GeneratorContext { private isSuccess = true; From 1ff6e73a73cc3d452bd67a6bacb990c4b9aaf74a Mon Sep 17 00:00:00 2001 From: Niels Swimberghe <3382717+Swimburger@users.noreply.github.com> Date: Mon, 8 Dec 2025 18:41:51 -0500 Subject: [PATCH 3/5] seed --- seed/ts-sdk/accept-header/README.md | 17 ++++++++++++++ seed/ts-sdk/alias-extends/README.md | 20 +++++++++++++++- seed/ts-sdk/alias/README.md | 17 ++++++++++++++ .../generate-endpoint-metadata/README.md | 20 +++++++++++++++- .../any-auth/no-custom-config/README.md | 20 +++++++++++++++- seed/ts-sdk/api-wide-base-path/README.md | 17 ++++++++++++++ .../audiences/no-custom-config/README.md | 20 +++++++++++++++- .../audiences/with-partner-audience/README.md | 17 ++++++++++++++ .../README.md | 17 ++++++++++++++ seed/ts-sdk/basic-auth/README.md | 17 ++++++++++++++ .../README.md | 17 ++++++++++++++ seed/ts-sdk/bytes-download/README.md | 18 +++++++++++++++ seed/ts-sdk/bytes-upload/README.md | 18 +++++++++++++++ seed/ts-sdk/client-side-params/README.md | 20 +++++++++++++++- seed/ts-sdk/content-type/README.md | 20 +++++++++++++++- .../ts-sdk/cross-package-type-names/README.md | 20 +++++++++++++++- .../enum/forward-compatible-enums/README.md | 20 +++++++++++++++- seed/ts-sdk/enum/no-custom-config/README.md | 20 +++++++++++++++- seed/ts-sdk/enum/serde/README.md | 20 +++++++++++++++- .../error-property/no-custom-config/README.md | 17 ++++++++++++++ .../error-property/union-utils/README.md | 17 ++++++++++++++ seed/ts-sdk/errors/README.md | 17 ++++++++++++++ .../examples-with-api-reference/README.md | 23 ++++++++++++++++++- .../examples/retain-original-casing/README.md | 20 +++++++++++++++- .../exhaustive/allow-extra-fields/README.md | 20 +++++++++++++++- .../exhaustive/bigint-serde-layer/README.md | 20 +++++++++++++++- seed/ts-sdk/exhaustive/bigint/README.md | 20 +++++++++++++++- .../consolidate-type-files/README.md | 20 +++++++++++++++- .../export-all-requests-at-root/README.md | 20 +++++++++++++++- .../exhaustive/multiple-exports/README.md | 21 ++++++++++++++++- .../exhaustive/never-throw-errors/README.md | 20 +++++++++++++++- .../exhaustive/no-custom-config/README.md | 20 +++++++++++++++- seed/ts-sdk/exhaustive/node-fetch/README.md | 20 +++++++++++++++- seed/ts-sdk/exhaustive/package-path/README.md | 20 +++++++++++++++- .../parameter-naming-camel-case/README.md | 20 +++++++++++++++- .../parameter-naming-original-name/README.md | 20 +++++++++++++++- .../parameter-naming-snake-case/README.md | 20 +++++++++++++++- .../parameter-naming-wire-value/README.md | 20 +++++++++++++++- .../retain-original-casing/README.md | 20 +++++++++++++++- seed/ts-sdk/exhaustive/serde-layer/README.md | 20 +++++++++++++++- seed/ts-sdk/exhaustive/use-jest/README.md | 20 +++++++++++++++- .../exhaustive/web-stream-wrapper/README.md | 20 +++++++++++++++- seed/ts-sdk/extends/README.md | 20 +++++++++++++++- seed/ts-sdk/extra-properties/README.md | 20 +++++++++++++++- .../file-download-response-headers/README.md | 18 +++++++++++++++ .../file-download/no-custom-config/README.md | 18 +++++++++++++++ .../file-download/stream-wrapper/README.md | 17 ++++++++++++++ seed/ts-sdk/file-upload-openapi/README.md | 21 ++++++++++++++++- .../file-upload/form-data-node16/README.md | 21 ++++++++++++++++- seed/ts-sdk/file-upload/inline/README.md | 21 ++++++++++++++++- .../file-upload/no-custom-config/README.md | 21 ++++++++++++++++- seed/ts-sdk/file-upload/serde/README.md | 21 ++++++++++++++++- seed/ts-sdk/file-upload/use-jest/README.md | 21 ++++++++++++++++- seed/ts-sdk/file-upload/wrapper/README.md | 21 ++++++++++++++++- seed/ts-sdk/folders/README.md | 17 ++++++++++++++ .../README.md | 17 ++++++++++++++ seed/ts-sdk/header-auth/README.md | 17 ++++++++++++++ seed/ts-sdk/http-head/README.md | 20 +++++++++++++++- seed/ts-sdk/idempotency-headers/README.md | 20 +++++++++++++++- .../imdb/branded-string-aliases/README.md | 17 ++++++++++++++ seed/ts-sdk/imdb/no-custom-config/README.md | 17 ++++++++++++++ seed/ts-sdk/imdb/omit-undefined/README.md | 17 ++++++++++++++ seed/ts-sdk/inferred-auth-explicit/README.md | 20 +++++++++++++++- .../README.md | 20 +++++++++++++++- seed/ts-sdk/inferred-auth-implicit/README.md | 20 +++++++++++++++- seed/ts-sdk/license/README.md | 17 ++++++++++++++ seed/ts-sdk/literal/README.md | 20 +++++++++++++++- .../mixed-case/no-custom-config/README.md | 20 +++++++++++++++- .../retain-original-casing/README.md | 20 +++++++++++++++- seed/ts-sdk/mixed-file-directory/README.md | 20 +++++++++++++++- seed/ts-sdk/multi-line-docs/README.md | 20 +++++++++++++++- .../README.md | 20 +++++++++++++++- seed/ts-sdk/multi-url-environment/README.md | 20 +++++++++++++++- seed/ts-sdk/multiple-request-bodies/README.md | 21 ++++++++++++++++- seed/ts-sdk/no-environment/README.md | 17 ++++++++++++++ seed/ts-sdk/no-retries/README.md | 17 ++++++++++++++ seed/ts-sdk/nullable-allof-extends/README.md | 17 ++++++++++++++ seed/ts-sdk/nullable-optional/README.md | 20 +++++++++++++++- seed/ts-sdk/nullable-request-body/README.md | 20 +++++++++++++++- seed/ts-sdk/nullable/README.md | 20 +++++++++++++++- .../oauth-client-credentials-custom/README.md | 20 +++++++++++++++- .../README.md | 20 +++++++++++++++- .../no-custom-config/README.md | 20 +++++++++++++++- .../token-override/README.md | 21 ++++++++++++++++- .../never-throw-errors/README.md | 20 +++++++++++++++- .../no-custom-config/README.md | 20 +++++++++++++++- .../README.md | 20 +++++++++++++++- .../no-custom-config/README.md | 20 +++++++++++++++- .../oauth-client-credentials/serde/README.md | 20 +++++++++++++++- .../token-override/README.md | 21 ++++++++++++++++- seed/ts-sdk/optional/README.md | 17 ++++++++++++++ seed/ts-sdk/package-yml/README.md | 17 ++++++++++++++ seed/ts-sdk/pagination-custom/README.md | 21 ++++++++++++++++- .../pagination/no-custom-config/README.md | 21 ++++++++++++++++- .../pagination/page-index-semantics/README.md | 21 ++++++++++++++++- .../README.md | 20 +++++++++++++++- .../inline-path-parameters-serde/README.md | 20 +++++++++++++++- .../inline-path-parameters/README.md | 20 +++++++++++++++- .../no-custom-config/README.md | 20 +++++++++++++++- .../parameter-naming-camel-case/README.md | 20 +++++++++++++++- .../parameter-naming-original-name/README.md | 20 +++++++++++++++- .../parameter-naming-snake-case/README.md | 20 +++++++++++++++- .../parameter-naming-wire-value/README.md | 20 +++++++++++++++- .../retain-original-casing/README.md | 20 +++++++++++++++- seed/ts-sdk/plain-text/README.md | 17 ++++++++++++++ .../generate-read-write-only-types/README.md | 17 ++++++++++++++ .../no-custom-config/README.md | 17 ++++++++++++++ .../README.md | 20 +++++++++++++++- .../ts-sdk/query-parameters-openapi/README.md | 20 +++++++++++++++- .../no-custom-config/README.md | 20 +++++++++++++++- .../parameter-naming-camel-case/README.md | 20 +++++++++++++++- .../parameter-naming-original-name/README.md | 20 +++++++++++++++- .../parameter-naming-snake-case/README.md | 20 +++++++++++++++- .../parameter-naming-wire-value/README.md | 20 +++++++++++++++- seed/ts-sdk/query-parameters/serde/README.md | 20 +++++++++++++++- .../flatten-request-parameters/README.md | 20 +++++++++++++++- .../no-custom-config/README.md | 20 +++++++++++++++- .../README.md | 20 +++++++++++++++- .../README.md | 20 +++++++++++++++- seed/ts-sdk/required-nullable/README.md | 20 +++++++++++++++- seed/ts-sdk/reserved-keywords/README.md | 20 +++++++++++++++- seed/ts-sdk/response-property/README.md | 17 ++++++++++++++ .../server-sent-event-examples/README.md | 21 ++++++++++++++++- seed/ts-sdk/server-sent-events/README.md | 21 ++++++++++++++++- .../simple-api/allow-custom-fetcher/README.md | 17 ++++++++++++++ .../simple-api/allow-extra-fields/README.md | 17 ++++++++++++++ seed/ts-sdk/simple-api/bundle/README.md | 17 ++++++++++++++ .../simple-api/custom-package-json/README.md | 17 ++++++++++++++ seed/ts-sdk/simple-api/jsr/README.md | 17 ++++++++++++++ .../simple-api/legacy-exports/README.md | 17 ++++++++++++++ .../simple-api/no-custom-config/README.md | 17 ++++++++++++++ seed/ts-sdk/simple-api/no-linter/README.md | 17 ++++++++++++++ seed/ts-sdk/simple-api/no-scripts/README.md | 17 ++++++++++++++ seed/ts-sdk/simple-api/oidc-token/README.md | 17 ++++++++++++++ .../simple-api/omit-fern-headers/README.md | 17 ++++++++++++++ seed/ts-sdk/simple-api/use-oxfmt/README.md | 17 ++++++++++++++ seed/ts-sdk/simple-api/use-oxlint/README.md | 17 ++++++++++++++ .../use-prettier-no-linter/README.md | 17 ++++++++++++++ seed/ts-sdk/simple-api/use-prettier/README.md | 17 ++++++++++++++ seed/ts-sdk/simple-api/use-yarn/README.md | 17 ++++++++++++++ seed/ts-sdk/simple-fhir/README.md | 17 ++++++++++++++ .../single-url-environment-default/README.md | 17 ++++++++++++++ .../README.md | 17 ++++++++++++++ seed/ts-sdk/streaming-parameter/README.md | 20 +++++++++++++++- .../streaming/no-custom-config/README.md | 21 ++++++++++++++++- seed/ts-sdk/streaming/serde-layer/README.md | 21 ++++++++++++++++- seed/ts-sdk/streaming/wrapper/README.md | 21 ++++++++++++++++- seed/ts-sdk/trace/exhaustive/README.md | 20 +++++++++++++++- seed/ts-sdk/trace/no-custom-config/README.md | 20 +++++++++++++++- seed/ts-sdk/trace/serde-no-throwing/README.md | 20 +++++++++++++++- seed/ts-sdk/trace/serde/README.md | 20 +++++++++++++++- seed/ts-sdk/ts-express-casing/README.md | 20 +++++++++++++++- seed/ts-sdk/ts-inline-types/inline/README.md | 20 +++++++++++++++- .../ts-inline-types/no-inline/README.md | 20 +++++++++++++++- .../README.md | 17 ++++++++++++++ .../no-custom-config/README.md | 20 +++++++++++++++- .../skip-response-validation/README.md | 20 +++++++++++++++- seed/ts-sdk/unions-with-local-date/README.md | 17 ++++++++++++++ seed/ts-sdk/unions/README.md | 17 ++++++++++++++ .../ts-sdk/unknown/no-custom-config/README.md | 17 ++++++++++++++ seed/ts-sdk/unknown/unknown-as-any/README.md | 17 ++++++++++++++ seed/ts-sdk/url-form-encoded/README.md | 20 +++++++++++++++- seed/ts-sdk/validation/README.md | 20 +++++++++++++++- seed/ts-sdk/variables/README.md | 17 ++++++++++++++ seed/ts-sdk/version-no-default/README.md | 17 ++++++++++++++ seed/ts-sdk/version/README.md | 17 ++++++++++++++ .../websockets/README.md | 20 +++++++++++++++- 167 files changed, 3083 insertions(+), 109 deletions(-) diff --git a/seed/ts-sdk/accept-header/README.md b/seed/ts-sdk/accept-header/README.md index 1d4999d8dd0d..e4b12cd51c65 100644 --- a/seed/ts-sdk/accept-header/README.md +++ b/seed/ts-sdk/accept-header/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/alias-extends/README.md b/seed/ts-sdk/alias-extends/README.md index 13964e52c9f5..9d3f7d4c133b 100644 --- a/seed/ts-sdk/alias-extends/README.md +++ b/seed/ts-sdk/alias-extends/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -29,7 +47,7 @@ await client.extendedInlineRequestBody({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/alias/README.md b/seed/ts-sdk/alias/README.md index 97dcc532020b..58189dccee4f 100644 --- a/seed/ts-sdk/alias/README.md +++ b/seed/ts-sdk/alias/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/any-auth/generate-endpoint-metadata/README.md b/seed/ts-sdk/any-auth/generate-endpoint-metadata/README.md index 52a9bbd660f6..f29560a637a4 100644 --- a/seed/ts-sdk/any-auth/generate-endpoint-metadata/README.md +++ b/seed/ts-sdk/any-auth/generate-endpoint-metadata/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -30,7 +48,7 @@ await client.auth.getToken({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/any-auth/no-custom-config/README.md b/seed/ts-sdk/any-auth/no-custom-config/README.md index 52a9bbd660f6..f29560a637a4 100644 --- a/seed/ts-sdk/any-auth/no-custom-config/README.md +++ b/seed/ts-sdk/any-auth/no-custom-config/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -30,7 +48,7 @@ await client.auth.getToken({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/api-wide-base-path/README.md b/seed/ts-sdk/api-wide-base-path/README.md index 3dbad0700800..5503a03871cc 100644 --- a/seed/ts-sdk/api-wide-base-path/README.md +++ b/seed/ts-sdk/api-wide-base-path/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/audiences/no-custom-config/README.md b/seed/ts-sdk/audiences/no-custom-config/README.md index 7661f1fdfb11..868462decfb3 100644 --- a/seed/ts-sdk/audiences/no-custom-config/README.md +++ b/seed/ts-sdk/audiences/no-custom-config/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -30,7 +48,7 @@ await client.foo.find({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/audiences/with-partner-audience/README.md b/seed/ts-sdk/audiences/with-partner-audience/README.md index a2c7721f3b9b..f0fa7fc8f745 100644 --- a/seed/ts-sdk/audiences/with-partner-audience/README.md +++ b/seed/ts-sdk/audiences/with-partner-audience/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/basic-auth-environment-variables/README.md b/seed/ts-sdk/basic-auth-environment-variables/README.md index 52c6174c2a6c..ee019d13334e 100644 --- a/seed/ts-sdk/basic-auth-environment-variables/README.md +++ b/seed/ts-sdk/basic-auth-environment-variables/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/basic-auth/README.md b/seed/ts-sdk/basic-auth/README.md index 57775544ac9f..5c82ea627667 100644 --- a/seed/ts-sdk/basic-auth/README.md +++ b/seed/ts-sdk/basic-auth/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/bearer-token-environment-variable/README.md b/seed/ts-sdk/bearer-token-environment-variable/README.md index 470f5bc6a5b2..1357e5e74dfc 100644 --- a/seed/ts-sdk/bearer-token-environment-variable/README.md +++ b/seed/ts-sdk/bearer-token-environment-variable/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/bytes-download/README.md b/seed/ts-sdk/bytes-download/README.md index cf386ad72a0e..0d0e5e4b3e51 100644 --- a/seed/ts-sdk/bytes-download/README.md +++ b/seed/ts-sdk/bytes-download/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Binary Response](#binary-response) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/bytes-upload/README.md b/seed/ts-sdk/bytes-upload/README.md index fb3ea1df35f8..d58e52e97a16 100644 --- a/seed/ts-sdk/bytes-upload/README.md +++ b/seed/ts-sdk/bytes-upload/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [File Uploads](#file-uploads) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/client-side-params/README.md b/seed/ts-sdk/client-side-params/README.md index b5793c17d711..4e0895abf6d4 100644 --- a/seed/ts-sdk/client-side-params/README.md +++ b/seed/ts-sdk/client-side-params/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -35,7 +53,7 @@ await client.service.searchResources({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/content-type/README.md b/seed/ts-sdk/content-type/README.md index a97cd8304a3f..425756293917 100644 --- a/seed/ts-sdk/content-type/README.md +++ b/seed/ts-sdk/content-type/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -29,7 +47,7 @@ await client.service.patch({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/cross-package-type-names/README.md b/seed/ts-sdk/cross-package-type-names/README.md index 6f7b0d4b51a5..e6ab09f5e56e 100644 --- a/seed/ts-sdk/cross-package-type-names/README.md +++ b/seed/ts-sdk/cross-package-type-names/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -30,7 +48,7 @@ await client.foo.find({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/enum/forward-compatible-enums/README.md b/seed/ts-sdk/enum/forward-compatible-enums/README.md index 4fcbadc12fa5..6cdcf1c11080 100644 --- a/seed/ts-sdk/enum/forward-compatible-enums/README.md +++ b/seed/ts-sdk/enum/forward-compatible-enums/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -31,7 +49,7 @@ await client.headers.send({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/enum/no-custom-config/README.md b/seed/ts-sdk/enum/no-custom-config/README.md index 4fcbadc12fa5..6cdcf1c11080 100644 --- a/seed/ts-sdk/enum/no-custom-config/README.md +++ b/seed/ts-sdk/enum/no-custom-config/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -31,7 +49,7 @@ await client.headers.send({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/enum/serde/README.md b/seed/ts-sdk/enum/serde/README.md index 4fcbadc12fa5..6cdcf1c11080 100644 --- a/seed/ts-sdk/enum/serde/README.md +++ b/seed/ts-sdk/enum/serde/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -31,7 +49,7 @@ await client.headers.send({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/error-property/no-custom-config/README.md b/seed/ts-sdk/error-property/no-custom-config/README.md index 3dc481aa1d01..772146422941 100644 --- a/seed/ts-sdk/error-property/no-custom-config/README.md +++ b/seed/ts-sdk/error-property/no-custom-config/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/error-property/union-utils/README.md b/seed/ts-sdk/error-property/union-utils/README.md index 3dc481aa1d01..772146422941 100644 --- a/seed/ts-sdk/error-property/union-utils/README.md +++ b/seed/ts-sdk/error-property/union-utils/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/errors/README.md b/seed/ts-sdk/errors/README.md index 9ed94b2e2890..54c1b5092c99 100644 --- a/seed/ts-sdk/errors/README.md +++ b/seed/ts-sdk/errors/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/examples/examples-with-api-reference/README.md b/seed/ts-sdk/examples/examples-with-api-reference/README.md index 58aaa088d76d..f625e10651a4 100644 --- a/seed/ts-sdk/examples/examples-with-api-reference/README.md +++ b/seed/ts-sdk/examples/examples-with-api-reference/README.md @@ -7,6 +7,27 @@ The CustomName TypeScript library provides convenient access to the CustomName APIs from TypeScript. +## Table of Contents + +- [Documentation](#documentation) +- [Installation](#installation) +- [Reference](#reference) +- [Base Readme Custom Section](#base-readme-custom-section) +- [Override Section](#override-section) +- [Generator Invocation Custom Section](#generator-invocation-custom-section) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) + ## Documentation API reference documentation is available [here](https://www.docs.fernapi.com). @@ -65,7 +86,7 @@ await client.service.createMovie({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/examples/retain-original-casing/README.md b/seed/ts-sdk/examples/retain-original-casing/README.md index d6237caab546..8a8752809e5c 100644 --- a/seed/ts-sdk/examples/retain-original-casing/README.md +++ b/seed/ts-sdk/examples/retain-original-casing/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedExamplesClient({ environment: SeedExamplesEnvironment.Pro await client.echo("Hello world!\\n\\nwith\\n\\tnewlines"); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/exhaustive/allow-extra-fields/README.md b/seed/ts-sdk/exhaustive/allow-extra-fields/README.md index 140b1fb505f3..03b5f6a84cb0 100644 --- a/seed/ts-sdk/exhaustive/allow-extra-fields/README.md +++ b/seed/ts-sdk/exhaustive/allow-extra-fields/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedExhaustiveClient({ environment: "YOUR_BASE_URL", token: " await client.endpoints.container.getAndReturnListOfPrimitives(["string", "string"]); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/exhaustive/bigint-serde-layer/README.md b/seed/ts-sdk/exhaustive/bigint-serde-layer/README.md index 140b1fb505f3..03b5f6a84cb0 100644 --- a/seed/ts-sdk/exhaustive/bigint-serde-layer/README.md +++ b/seed/ts-sdk/exhaustive/bigint-serde-layer/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedExhaustiveClient({ environment: "YOUR_BASE_URL", token: " await client.endpoints.container.getAndReturnListOfPrimitives(["string", "string"]); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/exhaustive/bigint/README.md b/seed/ts-sdk/exhaustive/bigint/README.md index 140b1fb505f3..03b5f6a84cb0 100644 --- a/seed/ts-sdk/exhaustive/bigint/README.md +++ b/seed/ts-sdk/exhaustive/bigint/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedExhaustiveClient({ environment: "YOUR_BASE_URL", token: " await client.endpoints.container.getAndReturnListOfPrimitives(["string", "string"]); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/exhaustive/consolidate-type-files/README.md b/seed/ts-sdk/exhaustive/consolidate-type-files/README.md index 140b1fb505f3..03b5f6a84cb0 100644 --- a/seed/ts-sdk/exhaustive/consolidate-type-files/README.md +++ b/seed/ts-sdk/exhaustive/consolidate-type-files/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedExhaustiveClient({ environment: "YOUR_BASE_URL", token: " await client.endpoints.container.getAndReturnListOfPrimitives(["string", "string"]); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/exhaustive/export-all-requests-at-root/README.md b/seed/ts-sdk/exhaustive/export-all-requests-at-root/README.md index 140b1fb505f3..03b5f6a84cb0 100644 --- a/seed/ts-sdk/exhaustive/export-all-requests-at-root/README.md +++ b/seed/ts-sdk/exhaustive/export-all-requests-at-root/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedExhaustiveClient({ environment: "YOUR_BASE_URL", token: " await client.endpoints.container.getAndReturnListOfPrimitives(["string", "string"]); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/exhaustive/multiple-exports/README.md b/seed/ts-sdk/exhaustive/multiple-exports/README.md index e323e620fe9a..97448ed88397 100644 --- a/seed/ts-sdk/exhaustive/multiple-exports/README.md +++ b/seed/ts-sdk/exhaustive/multiple-exports/README.md @@ -5,6 +5,25 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Subpackage Exports](#subpackage-exports) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +45,7 @@ const client = new SeedExhaustiveClient({ environment: "YOUR_BASE_URL", token: " await client.endpoints.container.getAndReturnListOfPrimitives(["string", "string"]); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/exhaustive/never-throw-errors/README.md b/seed/ts-sdk/exhaustive/never-throw-errors/README.md index 140b1fb505f3..03b5f6a84cb0 100644 --- a/seed/ts-sdk/exhaustive/never-throw-errors/README.md +++ b/seed/ts-sdk/exhaustive/never-throw-errors/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedExhaustiveClient({ environment: "YOUR_BASE_URL", token: " await client.endpoints.container.getAndReturnListOfPrimitives(["string", "string"]); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/exhaustive/no-custom-config/README.md b/seed/ts-sdk/exhaustive/no-custom-config/README.md index 140b1fb505f3..03b5f6a84cb0 100644 --- a/seed/ts-sdk/exhaustive/no-custom-config/README.md +++ b/seed/ts-sdk/exhaustive/no-custom-config/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedExhaustiveClient({ environment: "YOUR_BASE_URL", token: " await client.endpoints.container.getAndReturnListOfPrimitives(["string", "string"]); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/exhaustive/node-fetch/README.md b/seed/ts-sdk/exhaustive/node-fetch/README.md index 3949afb3c7d5..90380377e65b 100644 --- a/seed/ts-sdk/exhaustive/node-fetch/README.md +++ b/seed/ts-sdk/exhaustive/node-fetch/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedExhaustiveClient({ environment: "YOUR_BASE_URL", token: " await client.endpoints.container.getAndReturnListOfPrimitives(["string", "string"]); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/exhaustive/package-path/README.md b/seed/ts-sdk/exhaustive/package-path/README.md index 140b1fb505f3..03b5f6a84cb0 100644 --- a/seed/ts-sdk/exhaustive/package-path/README.md +++ b/seed/ts-sdk/exhaustive/package-path/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedExhaustiveClient({ environment: "YOUR_BASE_URL", token: " await client.endpoints.container.getAndReturnListOfPrimitives(["string", "string"]); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/exhaustive/parameter-naming-camel-case/README.md b/seed/ts-sdk/exhaustive/parameter-naming-camel-case/README.md index 140b1fb505f3..03b5f6a84cb0 100644 --- a/seed/ts-sdk/exhaustive/parameter-naming-camel-case/README.md +++ b/seed/ts-sdk/exhaustive/parameter-naming-camel-case/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedExhaustiveClient({ environment: "YOUR_BASE_URL", token: " await client.endpoints.container.getAndReturnListOfPrimitives(["string", "string"]); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/exhaustive/parameter-naming-original-name/README.md b/seed/ts-sdk/exhaustive/parameter-naming-original-name/README.md index 140b1fb505f3..03b5f6a84cb0 100644 --- a/seed/ts-sdk/exhaustive/parameter-naming-original-name/README.md +++ b/seed/ts-sdk/exhaustive/parameter-naming-original-name/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedExhaustiveClient({ environment: "YOUR_BASE_URL", token: " await client.endpoints.container.getAndReturnListOfPrimitives(["string", "string"]); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/exhaustive/parameter-naming-snake-case/README.md b/seed/ts-sdk/exhaustive/parameter-naming-snake-case/README.md index 140b1fb505f3..03b5f6a84cb0 100644 --- a/seed/ts-sdk/exhaustive/parameter-naming-snake-case/README.md +++ b/seed/ts-sdk/exhaustive/parameter-naming-snake-case/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedExhaustiveClient({ environment: "YOUR_BASE_URL", token: " await client.endpoints.container.getAndReturnListOfPrimitives(["string", "string"]); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/exhaustive/parameter-naming-wire-value/README.md b/seed/ts-sdk/exhaustive/parameter-naming-wire-value/README.md index 140b1fb505f3..03b5f6a84cb0 100644 --- a/seed/ts-sdk/exhaustive/parameter-naming-wire-value/README.md +++ b/seed/ts-sdk/exhaustive/parameter-naming-wire-value/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedExhaustiveClient({ environment: "YOUR_BASE_URL", token: " await client.endpoints.container.getAndReturnListOfPrimitives(["string", "string"]); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/exhaustive/retain-original-casing/README.md b/seed/ts-sdk/exhaustive/retain-original-casing/README.md index 140b1fb505f3..03b5f6a84cb0 100644 --- a/seed/ts-sdk/exhaustive/retain-original-casing/README.md +++ b/seed/ts-sdk/exhaustive/retain-original-casing/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedExhaustiveClient({ environment: "YOUR_BASE_URL", token: " await client.endpoints.container.getAndReturnListOfPrimitives(["string", "string"]); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/exhaustive/serde-layer/README.md b/seed/ts-sdk/exhaustive/serde-layer/README.md index 140b1fb505f3..03b5f6a84cb0 100644 --- a/seed/ts-sdk/exhaustive/serde-layer/README.md +++ b/seed/ts-sdk/exhaustive/serde-layer/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedExhaustiveClient({ environment: "YOUR_BASE_URL", token: " await client.endpoints.container.getAndReturnListOfPrimitives(["string", "string"]); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/exhaustive/use-jest/README.md b/seed/ts-sdk/exhaustive/use-jest/README.md index 140b1fb505f3..03b5f6a84cb0 100644 --- a/seed/ts-sdk/exhaustive/use-jest/README.md +++ b/seed/ts-sdk/exhaustive/use-jest/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedExhaustiveClient({ environment: "YOUR_BASE_URL", token: " await client.endpoints.container.getAndReturnListOfPrimitives(["string", "string"]); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/exhaustive/web-stream-wrapper/README.md b/seed/ts-sdk/exhaustive/web-stream-wrapper/README.md index 140b1fb505f3..03b5f6a84cb0 100644 --- a/seed/ts-sdk/exhaustive/web-stream-wrapper/README.md +++ b/seed/ts-sdk/exhaustive/web-stream-wrapper/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedExhaustiveClient({ environment: "YOUR_BASE_URL", token: " await client.endpoints.container.getAndReturnListOfPrimitives(["string", "string"]); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/extends/README.md b/seed/ts-sdk/extends/README.md index d10d60c70f1d..a7124a4d8da6 100644 --- a/seed/ts-sdk/extends/README.md +++ b/seed/ts-sdk/extends/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -30,7 +48,7 @@ await client.extendedInlineRequestBody({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/extra-properties/README.md b/seed/ts-sdk/extra-properties/README.md index 2204de858819..3bf06c51fa02 100644 --- a/seed/ts-sdk/extra-properties/README.md +++ b/seed/ts-sdk/extra-properties/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -30,7 +48,7 @@ await client.user.createUser({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/file-download/file-download-response-headers/README.md b/seed/ts-sdk/file-download/file-download-response-headers/README.md index 6ce9b811380c..4910af9a98ec 100644 --- a/seed/ts-sdk/file-download/file-download-response-headers/README.md +++ b/seed/ts-sdk/file-download/file-download-response-headers/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Binary Response](#binary-response) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/file-download/no-custom-config/README.md b/seed/ts-sdk/file-download/no-custom-config/README.md index 6ce9b811380c..4910af9a98ec 100644 --- a/seed/ts-sdk/file-download/no-custom-config/README.md +++ b/seed/ts-sdk/file-download/no-custom-config/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Binary Response](#binary-response) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/file-download/stream-wrapper/README.md b/seed/ts-sdk/file-download/stream-wrapper/README.md index cc391007f89f..5d901cdac714 100644 --- a/seed/ts-sdk/file-download/stream-wrapper/README.md +++ b/seed/ts-sdk/file-download/stream-wrapper/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/file-upload-openapi/README.md b/seed/ts-sdk/file-upload-openapi/README.md index 5155a394f8da..7ad4c8aa9472 100644 --- a/seed/ts-sdk/file-upload-openapi/README.md +++ b/seed/ts-sdk/file-upload-openapi/README.md @@ -5,6 +5,25 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [File Uploads](#file-uploads) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -29,7 +48,7 @@ await client.fileUploadExample.uploadFile({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/file-upload/form-data-node16/README.md b/seed/ts-sdk/file-upload/form-data-node16/README.md index 9f931dfd28f6..fadb21b8a797 100644 --- a/seed/ts-sdk/file-upload/form-data-node16/README.md +++ b/seed/ts-sdk/file-upload/form-data-node16/README.md @@ -5,6 +5,25 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [File Uploads](#file-uploads) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -30,7 +49,7 @@ await client.service.justFile({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/file-upload/inline/README.md b/seed/ts-sdk/file-upload/inline/README.md index 9f931dfd28f6..fadb21b8a797 100644 --- a/seed/ts-sdk/file-upload/inline/README.md +++ b/seed/ts-sdk/file-upload/inline/README.md @@ -5,6 +5,25 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [File Uploads](#file-uploads) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -30,7 +49,7 @@ await client.service.justFile({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/file-upload/no-custom-config/README.md b/seed/ts-sdk/file-upload/no-custom-config/README.md index 9f931dfd28f6..fadb21b8a797 100644 --- a/seed/ts-sdk/file-upload/no-custom-config/README.md +++ b/seed/ts-sdk/file-upload/no-custom-config/README.md @@ -5,6 +5,25 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [File Uploads](#file-uploads) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -30,7 +49,7 @@ await client.service.justFile({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/file-upload/serde/README.md b/seed/ts-sdk/file-upload/serde/README.md index 9f931dfd28f6..fadb21b8a797 100644 --- a/seed/ts-sdk/file-upload/serde/README.md +++ b/seed/ts-sdk/file-upload/serde/README.md @@ -5,6 +5,25 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [File Uploads](#file-uploads) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -30,7 +49,7 @@ await client.service.justFile({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/file-upload/use-jest/README.md b/seed/ts-sdk/file-upload/use-jest/README.md index 9f931dfd28f6..fadb21b8a797 100644 --- a/seed/ts-sdk/file-upload/use-jest/README.md +++ b/seed/ts-sdk/file-upload/use-jest/README.md @@ -5,6 +5,25 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [File Uploads](#file-uploads) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -30,7 +49,7 @@ await client.service.justFile({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/file-upload/wrapper/README.md b/seed/ts-sdk/file-upload/wrapper/README.md index 9f931dfd28f6..fadb21b8a797 100644 --- a/seed/ts-sdk/file-upload/wrapper/README.md +++ b/seed/ts-sdk/file-upload/wrapper/README.md @@ -5,6 +5,25 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [File Uploads](#file-uploads) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -30,7 +49,7 @@ await client.service.justFile({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/folders/README.md b/seed/ts-sdk/folders/README.md index ba3005cfc297..c5db291ac7c6 100644 --- a/seed/ts-sdk/folders/README.md +++ b/seed/ts-sdk/folders/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/header-auth-environment-variable/README.md b/seed/ts-sdk/header-auth-environment-variable/README.md index d2e1df2324b8..893589d3d916 100644 --- a/seed/ts-sdk/header-auth-environment-variable/README.md +++ b/seed/ts-sdk/header-auth-environment-variable/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/header-auth/README.md b/seed/ts-sdk/header-auth/README.md index 08cb3b7567a3..1640ee91a77b 100644 --- a/seed/ts-sdk/header-auth/README.md +++ b/seed/ts-sdk/header-auth/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/http-head/README.md b/seed/ts-sdk/http-head/README.md index d2cbf64be832..5ec4d558844f 100644 --- a/seed/ts-sdk/http-head/README.md +++ b/seed/ts-sdk/http-head/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedHttpHeadClient({ environment: "YOUR_BASE_URL" }); await client.user.head(); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/idempotency-headers/README.md b/seed/ts-sdk/idempotency-headers/README.md index 06972b54635a..c6b093309f65 100644 --- a/seed/ts-sdk/idempotency-headers/README.md +++ b/seed/ts-sdk/idempotency-headers/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -29,7 +47,7 @@ await client.payment.create({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/imdb/branded-string-aliases/README.md b/seed/ts-sdk/imdb/branded-string-aliases/README.md index a3a97a70c052..48fe9ee2c0bd 100644 --- a/seed/ts-sdk/imdb/branded-string-aliases/README.md +++ b/seed/ts-sdk/imdb/branded-string-aliases/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/imdb/no-custom-config/README.md b/seed/ts-sdk/imdb/no-custom-config/README.md index a3a97a70c052..48fe9ee2c0bd 100644 --- a/seed/ts-sdk/imdb/no-custom-config/README.md +++ b/seed/ts-sdk/imdb/no-custom-config/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/imdb/omit-undefined/README.md b/seed/ts-sdk/imdb/omit-undefined/README.md index a3a97a70c052..48fe9ee2c0bd 100644 --- a/seed/ts-sdk/imdb/omit-undefined/README.md +++ b/seed/ts-sdk/imdb/omit-undefined/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/inferred-auth-explicit/README.md b/seed/ts-sdk/inferred-auth-explicit/README.md index 0e8d144a2aa1..f81ed33bcdee 100644 --- a/seed/ts-sdk/inferred-auth-explicit/README.md +++ b/seed/ts-sdk/inferred-auth-explicit/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -31,7 +49,7 @@ await client.auth.getTokenWithClientCredentials({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/inferred-auth-implicit-no-expiry/README.md b/seed/ts-sdk/inferred-auth-implicit-no-expiry/README.md index d64acb722652..92a3960a099a 100644 --- a/seed/ts-sdk/inferred-auth-implicit-no-expiry/README.md +++ b/seed/ts-sdk/inferred-auth-implicit-no-expiry/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -31,7 +49,7 @@ await client.auth.getTokenWithClientCredentials({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/inferred-auth-implicit/README.md b/seed/ts-sdk/inferred-auth-implicit/README.md index d49ce594e650..7d5246539a91 100644 --- a/seed/ts-sdk/inferred-auth-implicit/README.md +++ b/seed/ts-sdk/inferred-auth-implicit/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -31,7 +49,7 @@ await client.auth.getTokenWithClientCredentials({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/license/README.md b/seed/ts-sdk/license/README.md index 2a8bb51ed141..6b6ab4bcc5b2 100644 --- a/seed/ts-sdk/license/README.md +++ b/seed/ts-sdk/license/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/literal/README.md b/seed/ts-sdk/literal/README.md index 9bf1b1d09201..400dd498450c 100644 --- a/seed/ts-sdk/literal/README.md +++ b/seed/ts-sdk/literal/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -28,7 +46,7 @@ await client.headers.send({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/mixed-case/no-custom-config/README.md b/seed/ts-sdk/mixed-case/no-custom-config/README.md index c0a0b284e20c..873726d95d5d 100644 --- a/seed/ts-sdk/mixed-case/no-custom-config/README.md +++ b/seed/ts-sdk/mixed-case/no-custom-config/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedMixedCaseClient({ environment: "YOUR_BASE_URL" }); await client.service.getResource("rsc-xyz"); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/mixed-case/retain-original-casing/README.md b/seed/ts-sdk/mixed-case/retain-original-casing/README.md index c0a0b284e20c..873726d95d5d 100644 --- a/seed/ts-sdk/mixed-case/retain-original-casing/README.md +++ b/seed/ts-sdk/mixed-case/retain-original-casing/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedMixedCaseClient({ environment: "YOUR_BASE_URL" }); await client.service.getResource("rsc-xyz"); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/mixed-file-directory/README.md b/seed/ts-sdk/mixed-file-directory/README.md index 64ca53e43bec..7dcf6913d563 100644 --- a/seed/ts-sdk/mixed-file-directory/README.md +++ b/seed/ts-sdk/mixed-file-directory/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -28,7 +46,7 @@ await client.organization.create({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/multi-line-docs/README.md b/seed/ts-sdk/multi-line-docs/README.md index df381708f467..21e66bd7c826 100644 --- a/seed/ts-sdk/multi-line-docs/README.md +++ b/seed/ts-sdk/multi-line-docs/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -29,7 +47,7 @@ await client.user.createUser({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/multi-url-environment-no-default/README.md b/seed/ts-sdk/multi-url-environment-no-default/README.md index a2c0649e74e3..68908b29ad93 100644 --- a/seed/ts-sdk/multi-url-environment-no-default/README.md +++ b/seed/ts-sdk/multi-url-environment-no-default/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -28,7 +46,7 @@ await client.ec2.bootInstance({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/multi-url-environment/README.md b/seed/ts-sdk/multi-url-environment/README.md index 29cc194fa5c6..9ec147d31b1f 100644 --- a/seed/ts-sdk/multi-url-environment/README.md +++ b/seed/ts-sdk/multi-url-environment/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -28,7 +46,7 @@ await client.ec2.bootInstance({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/multiple-request-bodies/README.md b/seed/ts-sdk/multiple-request-bodies/README.md index 704f7666938c..819d6e1680e9 100644 --- a/seed/ts-sdk/multiple-request-bodies/README.md +++ b/seed/ts-sdk/multiple-request-bodies/README.md @@ -5,6 +5,25 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [File Uploads](#file-uploads) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +45,7 @@ const client = new SeedApiClient({ token: "YOUR_TOKEN" }); await client.uploadJsonDocument(); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/no-environment/README.md b/seed/ts-sdk/no-environment/README.md index 0dc8246ccecb..e329554700b5 100644 --- a/seed/ts-sdk/no-environment/README.md +++ b/seed/ts-sdk/no-environment/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/no-retries/README.md b/seed/ts-sdk/no-retries/README.md index 861c40996c5b..a8569018a5c7 100644 --- a/seed/ts-sdk/no-retries/README.md +++ b/seed/ts-sdk/no-retries/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/nullable-allof-extends/README.md b/seed/ts-sdk/nullable-allof-extends/README.md index 0ec63447db56..fd365d13b24a 100644 --- a/seed/ts-sdk/nullable-allof-extends/README.md +++ b/seed/ts-sdk/nullable-allof-extends/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/nullable-optional/README.md b/seed/ts-sdk/nullable-optional/README.md index 9879fd6a45e7..f74dc8da9f53 100644 --- a/seed/ts-sdk/nullable-optional/README.md +++ b/seed/ts-sdk/nullable-optional/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -39,7 +57,7 @@ await client.nullableOptional.createUser({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/nullable-request-body/README.md b/seed/ts-sdk/nullable-request-body/README.md index 94d698b4e429..31799cc48afb 100644 --- a/seed/ts-sdk/nullable-request-body/README.md +++ b/seed/ts-sdk/nullable-request-body/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -29,7 +47,7 @@ await client.testGroup.testMethodName({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/nullable/README.md b/seed/ts-sdk/nullable/README.md index c9da6b0d1a2b..b2c86d39fc78 100644 --- a/seed/ts-sdk/nullable/README.md +++ b/seed/ts-sdk/nullable/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -42,7 +60,7 @@ await client.nullable.createUser({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/oauth-client-credentials-custom/README.md b/seed/ts-sdk/oauth-client-credentials-custom/README.md index 35cf7b167a49..9ded6649e77d 100644 --- a/seed/ts-sdk/oauth-client-credentials-custom/README.md +++ b/seed/ts-sdk/oauth-client-credentials-custom/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -32,7 +50,7 @@ await client.auth.getTokenWithClientCredentials({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/oauth-client-credentials-default/README.md b/seed/ts-sdk/oauth-client-credentials-default/README.md index 32fc0d4651e6..17c45f7a357a 100644 --- a/seed/ts-sdk/oauth-client-credentials-default/README.md +++ b/seed/ts-sdk/oauth-client-credentials-default/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -29,7 +47,7 @@ await client.auth.getToken({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/oauth-client-credentials-environment-variables/no-custom-config/README.md b/seed/ts-sdk/oauth-client-credentials-environment-variables/no-custom-config/README.md index fb5fbba4e630..3b2a3c64768e 100644 --- a/seed/ts-sdk/oauth-client-credentials-environment-variables/no-custom-config/README.md +++ b/seed/ts-sdk/oauth-client-credentials-environment-variables/no-custom-config/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -30,7 +48,7 @@ await client.auth.getTokenWithClientCredentials({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/oauth-client-credentials-environment-variables/token-override/README.md b/seed/ts-sdk/oauth-client-credentials-environment-variables/token-override/README.md index 90fc2ece24bd..426a4df05b2a 100644 --- a/seed/ts-sdk/oauth-client-credentials-environment-variables/token-override/README.md +++ b/seed/ts-sdk/oauth-client-credentials-environment-variables/token-override/README.md @@ -5,6 +5,25 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Authentication](#authentication) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -61,7 +80,7 @@ const client = new SeedOauthClientCredentialsEnvironmentVariablesClient({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/oauth-client-credentials-nested-root/never-throw-errors/README.md b/seed/ts-sdk/oauth-client-credentials-nested-root/never-throw-errors/README.md index a04ac48d8eff..d9e25b993e85 100644 --- a/seed/ts-sdk/oauth-client-credentials-nested-root/never-throw-errors/README.md +++ b/seed/ts-sdk/oauth-client-credentials-nested-root/never-throw-errors/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -30,7 +48,7 @@ await client.auth.getToken({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/oauth-client-credentials-nested-root/no-custom-config/README.md b/seed/ts-sdk/oauth-client-credentials-nested-root/no-custom-config/README.md index a04ac48d8eff..d9e25b993e85 100644 --- a/seed/ts-sdk/oauth-client-credentials-nested-root/no-custom-config/README.md +++ b/seed/ts-sdk/oauth-client-credentials-nested-root/no-custom-config/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -30,7 +48,7 @@ await client.auth.getToken({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/oauth-client-credentials-with-variables/README.md b/seed/ts-sdk/oauth-client-credentials-with-variables/README.md index fb9258249b9d..ef7a080e1539 100644 --- a/seed/ts-sdk/oauth-client-credentials-with-variables/README.md +++ b/seed/ts-sdk/oauth-client-credentials-with-variables/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -30,7 +48,7 @@ await client.auth.getTokenWithClientCredentials({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/oauth-client-credentials/no-custom-config/README.md b/seed/ts-sdk/oauth-client-credentials/no-custom-config/README.md index 9829cad8c8f2..b4027cd19024 100644 --- a/seed/ts-sdk/oauth-client-credentials/no-custom-config/README.md +++ b/seed/ts-sdk/oauth-client-credentials/no-custom-config/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -30,7 +48,7 @@ await client.auth.getTokenWithClientCredentials({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/oauth-client-credentials/serde/README.md b/seed/ts-sdk/oauth-client-credentials/serde/README.md index 3ef7911c74e9..7349dd9eff40 100644 --- a/seed/ts-sdk/oauth-client-credentials/serde/README.md +++ b/seed/ts-sdk/oauth-client-credentials/serde/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -30,7 +48,7 @@ await client.auth.getTokenWithClientCredentials({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/oauth-client-credentials/token-override/README.md b/seed/ts-sdk/oauth-client-credentials/token-override/README.md index 2ffc26d7d6aa..5cb7545c8da5 100644 --- a/seed/ts-sdk/oauth-client-credentials/token-override/README.md +++ b/seed/ts-sdk/oauth-client-credentials/token-override/README.md @@ -5,6 +5,25 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Authentication](#authentication) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -61,7 +80,7 @@ const client = new SeedOauthClientCredentialsClient({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/optional/README.md b/seed/ts-sdk/optional/README.md index 7d17f5713142..455c8245e88f 100644 --- a/seed/ts-sdk/optional/README.md +++ b/seed/ts-sdk/optional/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/package-yml/README.md b/seed/ts-sdk/package-yml/README.md index 9e2f70d91852..b477dbaa609e 100644 --- a/seed/ts-sdk/package-yml/README.md +++ b/seed/ts-sdk/package-yml/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/pagination-custom/README.md b/seed/ts-sdk/pagination-custom/README.md index 7c55bb1641d9..94af120d4ea7 100644 --- a/seed/ts-sdk/pagination-custom/README.md +++ b/seed/ts-sdk/pagination-custom/README.md @@ -5,6 +5,25 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Pagination](#pagination) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -42,7 +61,7 @@ while (page.hasNextPage()) { const response = page.response; ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/pagination/no-custom-config/README.md b/seed/ts-sdk/pagination/no-custom-config/README.md index a481cad36a14..771e79f48790 100644 --- a/seed/ts-sdk/pagination/no-custom-config/README.md +++ b/seed/ts-sdk/pagination/no-custom-config/README.md @@ -5,6 +5,25 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Pagination](#pagination) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -58,7 +77,7 @@ while (page.hasNextPage()) { const response = page.response; ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/pagination/page-index-semantics/README.md b/seed/ts-sdk/pagination/page-index-semantics/README.md index a481cad36a14..771e79f48790 100644 --- a/seed/ts-sdk/pagination/page-index-semantics/README.md +++ b/seed/ts-sdk/pagination/page-index-semantics/README.md @@ -5,6 +5,25 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Pagination](#pagination) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -58,7 +77,7 @@ while (page.hasNextPage()) { const response = page.response; ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/path-parameters/inline-path-parameters-retain-original-casing/README.md b/seed/ts-sdk/path-parameters/inline-path-parameters-retain-original-casing/README.md index 42fb3565fba5..385fd5fde49b 100644 --- a/seed/ts-sdk/path-parameters/inline-path-parameters-retain-original-casing/README.md +++ b/seed/ts-sdk/path-parameters/inline-path-parameters-retain-original-casing/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -29,7 +47,7 @@ await client.user.createUser({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/path-parameters/inline-path-parameters-serde/README.md b/seed/ts-sdk/path-parameters/inline-path-parameters-serde/README.md index 42fb3565fba5..385fd5fde49b 100644 --- a/seed/ts-sdk/path-parameters/inline-path-parameters-serde/README.md +++ b/seed/ts-sdk/path-parameters/inline-path-parameters-serde/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -29,7 +47,7 @@ await client.user.createUser({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/path-parameters/inline-path-parameters/README.md b/seed/ts-sdk/path-parameters/inline-path-parameters/README.md index 42fb3565fba5..385fd5fde49b 100644 --- a/seed/ts-sdk/path-parameters/inline-path-parameters/README.md +++ b/seed/ts-sdk/path-parameters/inline-path-parameters/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -29,7 +47,7 @@ await client.user.createUser({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/path-parameters/no-custom-config/README.md b/seed/ts-sdk/path-parameters/no-custom-config/README.md index 42fb3565fba5..385fd5fde49b 100644 --- a/seed/ts-sdk/path-parameters/no-custom-config/README.md +++ b/seed/ts-sdk/path-parameters/no-custom-config/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -29,7 +47,7 @@ await client.user.createUser({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/path-parameters/parameter-naming-camel-case/README.md b/seed/ts-sdk/path-parameters/parameter-naming-camel-case/README.md index 42fb3565fba5..385fd5fde49b 100644 --- a/seed/ts-sdk/path-parameters/parameter-naming-camel-case/README.md +++ b/seed/ts-sdk/path-parameters/parameter-naming-camel-case/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -29,7 +47,7 @@ await client.user.createUser({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/path-parameters/parameter-naming-original-name/README.md b/seed/ts-sdk/path-parameters/parameter-naming-original-name/README.md index 42fb3565fba5..385fd5fde49b 100644 --- a/seed/ts-sdk/path-parameters/parameter-naming-original-name/README.md +++ b/seed/ts-sdk/path-parameters/parameter-naming-original-name/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -29,7 +47,7 @@ await client.user.createUser({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/path-parameters/parameter-naming-snake-case/README.md b/seed/ts-sdk/path-parameters/parameter-naming-snake-case/README.md index 42fb3565fba5..385fd5fde49b 100644 --- a/seed/ts-sdk/path-parameters/parameter-naming-snake-case/README.md +++ b/seed/ts-sdk/path-parameters/parameter-naming-snake-case/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -29,7 +47,7 @@ await client.user.createUser({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/path-parameters/parameter-naming-wire-value/README.md b/seed/ts-sdk/path-parameters/parameter-naming-wire-value/README.md index 42fb3565fba5..385fd5fde49b 100644 --- a/seed/ts-sdk/path-parameters/parameter-naming-wire-value/README.md +++ b/seed/ts-sdk/path-parameters/parameter-naming-wire-value/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -29,7 +47,7 @@ await client.user.createUser({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/path-parameters/retain-original-casing/README.md b/seed/ts-sdk/path-parameters/retain-original-casing/README.md index 42fb3565fba5..385fd5fde49b 100644 --- a/seed/ts-sdk/path-parameters/retain-original-casing/README.md +++ b/seed/ts-sdk/path-parameters/retain-original-casing/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -29,7 +47,7 @@ await client.user.createUser({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/plain-text/README.md b/seed/ts-sdk/plain-text/README.md index 63c7135f12bb..fc2b4fbc1fe1 100644 --- a/seed/ts-sdk/plain-text/README.md +++ b/seed/ts-sdk/plain-text/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/property-access/generate-read-write-only-types/README.md b/seed/ts-sdk/property-access/generate-read-write-only-types/README.md index 09b8dc777ef0..4652114b653d 100644 --- a/seed/ts-sdk/property-access/generate-read-write-only-types/README.md +++ b/seed/ts-sdk/property-access/generate-read-write-only-types/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/property-access/no-custom-config/README.md b/seed/ts-sdk/property-access/no-custom-config/README.md index f7f2843b6d94..d19533312166 100644 --- a/seed/ts-sdk/property-access/no-custom-config/README.md +++ b/seed/ts-sdk/property-access/no-custom-config/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/query-parameters-openapi-as-objects/README.md b/seed/ts-sdk/query-parameters-openapi-as-objects/README.md index 76fa86845d7a..8dd77a1af8c3 100644 --- a/seed/ts-sdk/query-parameters-openapi-as-objects/README.md +++ b/seed/ts-sdk/query-parameters-openapi-as-objects/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -69,7 +87,7 @@ await client.search({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/query-parameters-openapi/README.md b/seed/ts-sdk/query-parameters-openapi/README.md index 5e05fa5ae528..313f3e95a9df 100644 --- a/seed/ts-sdk/query-parameters-openapi/README.md +++ b/seed/ts-sdk/query-parameters-openapi/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -69,7 +87,7 @@ await client.search({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/query-parameters/no-custom-config/README.md b/seed/ts-sdk/query-parameters/no-custom-config/README.md index cf4c8d56c149..2a2ea3c911f1 100644 --- a/seed/ts-sdk/query-parameters/no-custom-config/README.md +++ b/seed/ts-sdk/query-parameters/no-custom-config/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -64,7 +82,7 @@ await client.user.getUsername({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/query-parameters/parameter-naming-camel-case/README.md b/seed/ts-sdk/query-parameters/parameter-naming-camel-case/README.md index cf4c8d56c149..2a2ea3c911f1 100644 --- a/seed/ts-sdk/query-parameters/parameter-naming-camel-case/README.md +++ b/seed/ts-sdk/query-parameters/parameter-naming-camel-case/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -64,7 +82,7 @@ await client.user.getUsername({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/query-parameters/parameter-naming-original-name/README.md b/seed/ts-sdk/query-parameters/parameter-naming-original-name/README.md index cf4c8d56c149..2a2ea3c911f1 100644 --- a/seed/ts-sdk/query-parameters/parameter-naming-original-name/README.md +++ b/seed/ts-sdk/query-parameters/parameter-naming-original-name/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -64,7 +82,7 @@ await client.user.getUsername({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/query-parameters/parameter-naming-snake-case/README.md b/seed/ts-sdk/query-parameters/parameter-naming-snake-case/README.md index 16eb781e6570..a2fa2510ce63 100644 --- a/seed/ts-sdk/query-parameters/parameter-naming-snake-case/README.md +++ b/seed/ts-sdk/query-parameters/parameter-naming-snake-case/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -64,7 +82,7 @@ await client.user.getUsername({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/query-parameters/parameter-naming-wire-value/README.md b/seed/ts-sdk/query-parameters/parameter-naming-wire-value/README.md index cf4c8d56c149..2a2ea3c911f1 100644 --- a/seed/ts-sdk/query-parameters/parameter-naming-wire-value/README.md +++ b/seed/ts-sdk/query-parameters/parameter-naming-wire-value/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -64,7 +82,7 @@ await client.user.getUsername({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/query-parameters/serde/README.md b/seed/ts-sdk/query-parameters/serde/README.md index 49fe3dbe3f63..4c4170693756 100644 --- a/seed/ts-sdk/query-parameters/serde/README.md +++ b/seed/ts-sdk/query-parameters/serde/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -64,7 +82,7 @@ await client.user.getUsername({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/request-parameters/flatten-request-parameters/README.md b/seed/ts-sdk/request-parameters/flatten-request-parameters/README.md index 7b0d17ec5470..12900d85ddc6 100644 --- a/seed/ts-sdk/request-parameters/flatten-request-parameters/README.md +++ b/seed/ts-sdk/request-parameters/flatten-request-parameters/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -31,7 +49,7 @@ await client.user.createUsername({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/request-parameters/no-custom-config/README.md b/seed/ts-sdk/request-parameters/no-custom-config/README.md index 7b0d17ec5470..12900d85ddc6 100644 --- a/seed/ts-sdk/request-parameters/no-custom-config/README.md +++ b/seed/ts-sdk/request-parameters/no-custom-config/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -31,7 +49,7 @@ await client.user.createUsername({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/request-parameters/use-big-int-and-default-request-parameter-values/README.md b/seed/ts-sdk/request-parameters/use-big-int-and-default-request-parameter-values/README.md index 7b0d17ec5470..12900d85ddc6 100644 --- a/seed/ts-sdk/request-parameters/use-big-int-and-default-request-parameter-values/README.md +++ b/seed/ts-sdk/request-parameters/use-big-int-and-default-request-parameter-values/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -31,7 +49,7 @@ await client.user.createUsername({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/request-parameters/use-default-request-parameter-values/README.md b/seed/ts-sdk/request-parameters/use-default-request-parameter-values/README.md index 7b0d17ec5470..12900d85ddc6 100644 --- a/seed/ts-sdk/request-parameters/use-default-request-parameter-values/README.md +++ b/seed/ts-sdk/request-parameters/use-default-request-parameter-values/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -31,7 +49,7 @@ await client.user.createUsername({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/required-nullable/README.md b/seed/ts-sdk/required-nullable/README.md index 07a5c327ad8f..2683fac6cb45 100644 --- a/seed/ts-sdk/required-nullable/README.md +++ b/seed/ts-sdk/required-nullable/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -29,7 +47,7 @@ await client.getFoo({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/reserved-keywords/README.md b/seed/ts-sdk/reserved-keywords/README.md index e7d175771e6a..3bbcbf12ec56 100644 --- a/seed/ts-sdk/reserved-keywords/README.md +++ b/seed/ts-sdk/reserved-keywords/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -28,7 +46,7 @@ await client.package.test({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/response-property/README.md b/seed/ts-sdk/response-property/README.md index b5ba355a9ceb..e57aee6e1c7b 100644 --- a/seed/ts-sdk/response-property/README.md +++ b/seed/ts-sdk/response-property/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/server-sent-event-examples/README.md b/seed/ts-sdk/server-sent-event-examples/README.md index 8faac53410dd..60e3e3f8a9fa 100644 --- a/seed/ts-sdk/server-sent-event-examples/README.md +++ b/seed/ts-sdk/server-sent-event-examples/README.md @@ -5,6 +5,25 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Streaming Response](#streaming-response) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -31,7 +50,7 @@ for await (const item of response) { } ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/server-sent-events/README.md b/seed/ts-sdk/server-sent-events/README.md index 671d35335582..7a7c2d9939e9 100644 --- a/seed/ts-sdk/server-sent-events/README.md +++ b/seed/ts-sdk/server-sent-events/README.md @@ -5,6 +5,25 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Streaming Response](#streaming-response) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -31,7 +50,7 @@ for await (const item of response) { } ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/simple-api/allow-custom-fetcher/README.md b/seed/ts-sdk/simple-api/allow-custom-fetcher/README.md index 45de349d7f79..229fedd7a665 100644 --- a/seed/ts-sdk/simple-api/allow-custom-fetcher/README.md +++ b/seed/ts-sdk/simple-api/allow-custom-fetcher/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/simple-api/allow-extra-fields/README.md b/seed/ts-sdk/simple-api/allow-extra-fields/README.md index 45de349d7f79..229fedd7a665 100644 --- a/seed/ts-sdk/simple-api/allow-extra-fields/README.md +++ b/seed/ts-sdk/simple-api/allow-extra-fields/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/simple-api/bundle/README.md b/seed/ts-sdk/simple-api/bundle/README.md index 45de349d7f79..229fedd7a665 100644 --- a/seed/ts-sdk/simple-api/bundle/README.md +++ b/seed/ts-sdk/simple-api/bundle/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/simple-api/custom-package-json/README.md b/seed/ts-sdk/simple-api/custom-package-json/README.md index 45de349d7f79..229fedd7a665 100644 --- a/seed/ts-sdk/simple-api/custom-package-json/README.md +++ b/seed/ts-sdk/simple-api/custom-package-json/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/simple-api/jsr/README.md b/seed/ts-sdk/simple-api/jsr/README.md index 45de349d7f79..229fedd7a665 100644 --- a/seed/ts-sdk/simple-api/jsr/README.md +++ b/seed/ts-sdk/simple-api/jsr/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/simple-api/legacy-exports/README.md b/seed/ts-sdk/simple-api/legacy-exports/README.md index 45de349d7f79..229fedd7a665 100644 --- a/seed/ts-sdk/simple-api/legacy-exports/README.md +++ b/seed/ts-sdk/simple-api/legacy-exports/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/simple-api/no-custom-config/README.md b/seed/ts-sdk/simple-api/no-custom-config/README.md index 45de349d7f79..229fedd7a665 100644 --- a/seed/ts-sdk/simple-api/no-custom-config/README.md +++ b/seed/ts-sdk/simple-api/no-custom-config/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/simple-api/no-linter/README.md b/seed/ts-sdk/simple-api/no-linter/README.md index 45de349d7f79..229fedd7a665 100644 --- a/seed/ts-sdk/simple-api/no-linter/README.md +++ b/seed/ts-sdk/simple-api/no-linter/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/simple-api/no-scripts/README.md b/seed/ts-sdk/simple-api/no-scripts/README.md index 45de349d7f79..229fedd7a665 100644 --- a/seed/ts-sdk/simple-api/no-scripts/README.md +++ b/seed/ts-sdk/simple-api/no-scripts/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/simple-api/oidc-token/README.md b/seed/ts-sdk/simple-api/oidc-token/README.md index 03a5b44f90e6..55c2ab02a0bb 100644 --- a/seed/ts-sdk/simple-api/oidc-token/README.md +++ b/seed/ts-sdk/simple-api/oidc-token/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/simple-api/omit-fern-headers/README.md b/seed/ts-sdk/simple-api/omit-fern-headers/README.md index 45de349d7f79..229fedd7a665 100644 --- a/seed/ts-sdk/simple-api/omit-fern-headers/README.md +++ b/seed/ts-sdk/simple-api/omit-fern-headers/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/simple-api/use-oxfmt/README.md b/seed/ts-sdk/simple-api/use-oxfmt/README.md index 45de349d7f79..229fedd7a665 100644 --- a/seed/ts-sdk/simple-api/use-oxfmt/README.md +++ b/seed/ts-sdk/simple-api/use-oxfmt/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/simple-api/use-oxlint/README.md b/seed/ts-sdk/simple-api/use-oxlint/README.md index 45de349d7f79..229fedd7a665 100644 --- a/seed/ts-sdk/simple-api/use-oxlint/README.md +++ b/seed/ts-sdk/simple-api/use-oxlint/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/simple-api/use-prettier-no-linter/README.md b/seed/ts-sdk/simple-api/use-prettier-no-linter/README.md index 0280030fc256..cb1dd89c3128 100644 --- a/seed/ts-sdk/simple-api/use-prettier-no-linter/README.md +++ b/seed/ts-sdk/simple-api/use-prettier-no-linter/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/simple-api/use-prettier/README.md b/seed/ts-sdk/simple-api/use-prettier/README.md index 0280030fc256..cb1dd89c3128 100644 --- a/seed/ts-sdk/simple-api/use-prettier/README.md +++ b/seed/ts-sdk/simple-api/use-prettier/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/simple-api/use-yarn/README.md b/seed/ts-sdk/simple-api/use-yarn/README.md index 45de349d7f79..229fedd7a665 100644 --- a/seed/ts-sdk/simple-api/use-yarn/README.md +++ b/seed/ts-sdk/simple-api/use-yarn/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/simple-fhir/README.md b/seed/ts-sdk/simple-fhir/README.md index 79bdc45778fc..4f05d313b491 100644 --- a/seed/ts-sdk/simple-fhir/README.md +++ b/seed/ts-sdk/simple-fhir/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/single-url-environment-default/README.md b/seed/ts-sdk/single-url-environment-default/README.md index d112c921ba57..9fa2ae8d61d4 100644 --- a/seed/ts-sdk/single-url-environment-default/README.md +++ b/seed/ts-sdk/single-url-environment-default/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/single-url-environment-no-default/README.md b/seed/ts-sdk/single-url-environment-no-default/README.md index 0ffba8ebcc1c..03d5bac8d4d6 100644 --- a/seed/ts-sdk/single-url-environment-no-default/README.md +++ b/seed/ts-sdk/single-url-environment-no-default/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/streaming-parameter/README.md b/seed/ts-sdk/streaming-parameter/README.md index 7760a97f17da..49fcd50c821e 100644 --- a/seed/ts-sdk/streaming-parameter/README.md +++ b/seed/ts-sdk/streaming-parameter/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -32,7 +50,7 @@ for await (const item of response) { } ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/streaming/no-custom-config/README.md b/seed/ts-sdk/streaming/no-custom-config/README.md index 4045cf5d612d..9d9de17bf67c 100644 --- a/seed/ts-sdk/streaming/no-custom-config/README.md +++ b/seed/ts-sdk/streaming/no-custom-config/README.md @@ -5,6 +5,25 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Streaming Response](#streaming-response) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -31,7 +50,7 @@ for await (const item of response) { } ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/streaming/serde-layer/README.md b/seed/ts-sdk/streaming/serde-layer/README.md index 773d88f557ec..824328553d0a 100644 --- a/seed/ts-sdk/streaming/serde-layer/README.md +++ b/seed/ts-sdk/streaming/serde-layer/README.md @@ -5,6 +5,25 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Streaming Response](#streaming-response) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -31,7 +50,7 @@ for await (const item of response) { } ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/streaming/wrapper/README.md b/seed/ts-sdk/streaming/wrapper/README.md index 4045cf5d612d..9d9de17bf67c 100644 --- a/seed/ts-sdk/streaming/wrapper/README.md +++ b/seed/ts-sdk/streaming/wrapper/README.md @@ -5,6 +5,25 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Streaming Response](#streaming-response) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -31,7 +50,7 @@ for await (const item of response) { } ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/trace/exhaustive/README.md b/seed/ts-sdk/trace/exhaustive/README.md index 791a6c6fbc90..37736d55b6da 100644 --- a/seed/ts-sdk/trace/exhaustive/README.md +++ b/seed/ts-sdk/trace/exhaustive/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -28,7 +46,7 @@ await client.admin.updateTestSubmissionStatus(SeedTrace.SubmissionId("d5e9c84f-c }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/trace/no-custom-config/README.md b/seed/ts-sdk/trace/no-custom-config/README.md index 82cc7ebf8f1d..3309822f6ddc 100644 --- a/seed/ts-sdk/trace/no-custom-config/README.md +++ b/seed/ts-sdk/trace/no-custom-config/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -28,7 +46,7 @@ await client.admin.updateTestSubmissionStatus("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ff }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/trace/serde-no-throwing/README.md b/seed/ts-sdk/trace/serde-no-throwing/README.md index 82cc7ebf8f1d..3309822f6ddc 100644 --- a/seed/ts-sdk/trace/serde-no-throwing/README.md +++ b/seed/ts-sdk/trace/serde-no-throwing/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -28,7 +46,7 @@ await client.admin.updateTestSubmissionStatus("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ff }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/trace/serde/README.md b/seed/ts-sdk/trace/serde/README.md index 82cc7ebf8f1d..3309822f6ddc 100644 --- a/seed/ts-sdk/trace/serde/README.md +++ b/seed/ts-sdk/trace/serde/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -28,7 +46,7 @@ await client.admin.updateTestSubmissionStatus("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ff }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/ts-express-casing/README.md b/seed/ts-sdk/ts-express-casing/README.md index e43f099bb102..42073afb0e9e 100644 --- a/seed/ts-sdk/ts-express-casing/README.md +++ b/seed/ts-sdk/ts-express-casing/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -30,7 +48,7 @@ await client.imdb.createMovie({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/ts-inline-types/inline/README.md b/seed/ts-sdk/ts-inline-types/inline/README.md index bb83bc59434a..46fe1eaafe14 100644 --- a/seed/ts-sdk/ts-inline-types/inline/README.md +++ b/seed/ts-sdk/ts-inline-types/inline/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -31,7 +49,7 @@ await client.getRoot({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/ts-inline-types/no-inline/README.md b/seed/ts-sdk/ts-inline-types/no-inline/README.md index bb83bc59434a..46fe1eaafe14 100644 --- a/seed/ts-sdk/ts-inline-types/no-inline/README.md +++ b/seed/ts-sdk/ts-inline-types/no-inline/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -31,7 +49,7 @@ await client.getRoot({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/undiscriminated-union-with-response-property/README.md b/seed/ts-sdk/undiscriminated-union-with-response-property/README.md index ed06cdc86a36..6425225803e3 100644 --- a/seed/ts-sdk/undiscriminated-union-with-response-property/README.md +++ b/seed/ts-sdk/undiscriminated-union-with-response-property/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/undiscriminated-unions/no-custom-config/README.md b/seed/ts-sdk/undiscriminated-unions/no-custom-config/README.md index 23cddbdeccdc..6a43e23fdeb9 100644 --- a/seed/ts-sdk/undiscriminated-unions/no-custom-config/README.md +++ b/seed/ts-sdk/undiscriminated-unions/no-custom-config/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedUndiscriminatedUnionsClient({ environment: "YOUR_BASE_URL await client.union.get("string"); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/undiscriminated-unions/skip-response-validation/README.md b/seed/ts-sdk/undiscriminated-unions/skip-response-validation/README.md index 23cddbdeccdc..6a43e23fdeb9 100644 --- a/seed/ts-sdk/undiscriminated-unions/skip-response-validation/README.md +++ b/seed/ts-sdk/undiscriminated-unions/skip-response-validation/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -26,7 +44,7 @@ const client = new SeedUndiscriminatedUnionsClient({ environment: "YOUR_BASE_URL await client.union.get("string"); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/unions-with-local-date/README.md b/seed/ts-sdk/unions-with-local-date/README.md index 46bd4f4e79ac..c9f52a01c80a 100644 --- a/seed/ts-sdk/unions-with-local-date/README.md +++ b/seed/ts-sdk/unions-with-local-date/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/unions/README.md b/seed/ts-sdk/unions/README.md index b031ba2bc311..a11206738bbb 100644 --- a/seed/ts-sdk/unions/README.md +++ b/seed/ts-sdk/unions/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/unknown/no-custom-config/README.md b/seed/ts-sdk/unknown/no-custom-config/README.md index 0efe47f0f294..494ce868160a 100644 --- a/seed/ts-sdk/unknown/no-custom-config/README.md +++ b/seed/ts-sdk/unknown/no-custom-config/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/unknown/unknown-as-any/README.md b/seed/ts-sdk/unknown/unknown-as-any/README.md index 0efe47f0f294..494ce868160a 100644 --- a/seed/ts-sdk/unknown/unknown-as-any/README.md +++ b/seed/ts-sdk/unknown/unknown-as-any/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/url-form-encoded/README.md b/seed/ts-sdk/url-form-encoded/README.md index 0e9b8c9059d5..ab33329997b0 100644 --- a/seed/ts-sdk/url-form-encoded/README.md +++ b/seed/ts-sdk/url-form-encoded/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -29,7 +47,7 @@ await client.submitFormData({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/validation/README.md b/seed/ts-sdk/validation/README.md index 14ea3e078a70..8b27a8d29203 100644 --- a/seed/ts-sdk/validation/README.md +++ b/seed/ts-sdk/validation/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -31,7 +49,7 @@ await client.create({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/seed/ts-sdk/variables/README.md b/seed/ts-sdk/variables/README.md index 63c07ee09875..c5b99bfc4f27 100644 --- a/seed/ts-sdk/variables/README.md +++ b/seed/ts-sdk/variables/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/version-no-default/README.md b/seed/ts-sdk/version-no-default/README.md index a7ee7e2984ca..d9c2b59eff15 100644 --- a/seed/ts-sdk/version-no-default/README.md +++ b/seed/ts-sdk/version-no-default/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/version/README.md b/seed/ts-sdk/version/README.md index f53c7992ef83..f43d5cf8afe5 100644 --- a/seed/ts-sdk/version/README.md +++ b/seed/ts-sdk/version/README.md @@ -5,6 +5,23 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh diff --git a/seed/ts-sdk/websocket-inferred-auth/websockets/README.md b/seed/ts-sdk/websocket-inferred-auth/websockets/README.md index e7fc612e6315..4fd8e51e5cbe 100644 --- a/seed/ts-sdk/websocket-inferred-auth/websockets/README.md +++ b/seed/ts-sdk/websocket-inferred-auth/websockets/README.md @@ -5,6 +5,24 @@ The Seed TypeScript library provides convenient access to the Seed APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Logging](#logging) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -31,7 +49,7 @@ await client.auth.getTokenWithClientCredentials({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: From 4d9895e693c7740cca8c8ed3010ab6ea5e420c06 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Fri, 12 Dec 2025 05:41:46 +0000 Subject: [PATCH 4/5] test(typescript): Add unit tests for npmPackageInfoFromPublishConfig Co-Authored-By: Niels Swimberghe <3382717+Swimburger@users.noreply.github.com> --- .../src/AbstractGeneratorCli.ts | 49 +--- .../npmPackageInfoFromPublishConfig.test.ts | 255 ++++++++++++++++++ .../src/npmPackageInfoFromPublishConfig.ts | 57 ++++ 3 files changed, 314 insertions(+), 47 deletions(-) create mode 100644 generators/typescript/utils/abstract-generator-cli/src/__test__/npmPackageInfoFromPublishConfig.test.ts create mode 100644 generators/typescript/utils/abstract-generator-cli/src/npmPackageInfoFromPublishConfig.ts diff --git a/generators/typescript/utils/abstract-generator-cli/src/AbstractGeneratorCli.ts b/generators/typescript/utils/abstract-generator-cli/src/AbstractGeneratorCli.ts index 693f817fd572..85b53edf2b2e 100644 --- a/generators/typescript/utils/abstract-generator-cli/src/AbstractGeneratorCli.ts +++ b/generators/typescript/utils/abstract-generator-cli/src/AbstractGeneratorCli.ts @@ -11,19 +11,18 @@ import { assertNever } from "@fern-api/core-utils"; import { AbsoluteFilePath, join, RelativeFilePath } from "@fern-api/fs-utils"; import { CONSOLE_LOGGER, createLogger, Logger, LogLevel } from "@fern-api/logger"; import { createLoggingExecutable } from "@fern-api/logging-execa"; -import { FernIr, serialization } from "@fern-fern/ir-sdk"; +import { serialization } from "@fern-fern/ir-sdk"; import { IntermediateRepresentation } from "@fern-fern/ir-sdk/api"; import { constructNpmPackage, - constructNpmPackageArgs, constructNpmPackageFromArgs, - getRepoUrlFromUrl, NpmPackage, PersistedTypescriptProject } from "@fern-typescript/commons"; import { GeneratorContext } from "@fern-typescript/contexts"; import { writeFile } from "fs/promises"; import tmp from "tmp-promise"; +import { npmPackageInfoFromPublishConfig } from "./npmPackageInfoFromPublishConfig"; import { publishPackage } from "./publishPackage"; import { writeGenerationMetadata } from "./writeGenerationMetadata"; import { writeGitHubWorkflows } from "./writeGitHubWorkflows"; @@ -304,50 +303,6 @@ export abstract class AbstractGeneratorCli { } } -function npmPackageInfoFromPublishConfig( - config: FernGeneratorExec.GeneratorConfig, - publishConfig: FernIr.PublishingConfig | undefined, - isPackagePrivate: boolean -): constructNpmPackageArgs { - let args = {}; - if (publishConfig?.type === "github" || publishConfig?.type === "direct" || publishConfig?.type === "filesystem") { - const target = publishConfig?.type === "filesystem" ? publishConfig.publishTarget : publishConfig.target; - if (target?.type === "npm") { - args = { - packageName: target.packageName, - version: target.version, - repoUrl: getRepoUrl(publishConfig), - publishInfo: undefined, - licenseConfig: config.license - }; - } - } - return { - ...args, - isPackagePrivate - }; -} - -function getRepoUrl( - publishConfig: FernIr.PublishingConfig.Github | FernIr.PublishingConfig.Direct | FernIr.PublishingConfig.Filesystem -): string | undefined { - const url = publishConfig._visit({ - github: (value) => { - if (value.owner != null && value.repo != null) { - return `https://github.com/${value.owner}/${value.repo}`; - } - return value.uri; - }, - direct: () => undefined, - filesystem: () => undefined, - _other: () => undefined - }); - if (!url) { - return undefined; - } - return getRepoUrlFromUrl(url); -} - class GeneratorContextImpl implements GeneratorContext { private isSuccess = true; diff --git a/generators/typescript/utils/abstract-generator-cli/src/__test__/npmPackageInfoFromPublishConfig.test.ts b/generators/typescript/utils/abstract-generator-cli/src/__test__/npmPackageInfoFromPublishConfig.test.ts new file mode 100644 index 000000000000..3dc5576f37f9 --- /dev/null +++ b/generators/typescript/utils/abstract-generator-cli/src/__test__/npmPackageInfoFromPublishConfig.test.ts @@ -0,0 +1,255 @@ +import { FernGeneratorExec } from "@fern-api/base-generator"; +import { FernIr } from "@fern-fern/ir-sdk"; +import { describe, expect, it } from "vitest"; +import { npmPackageInfoFromPublishConfig } from "../npmPackageInfoFromPublishConfig"; + +describe("npmPackageInfoFromPublishConfig", () => { + const createMockConfig = (license?: FernGeneratorExec.LicenseConfig): FernGeneratorExec.GeneratorConfig => { + return { + dryRun: false, + irFilepath: "/path/to/ir.json", + output: { + path: "/output", + mode: FernGeneratorExec.OutputMode.downloadFiles() + }, + organization: "test-org", + workspaceName: "test-workspace", + environment: { + type: "local" + }, + customConfig: {}, + whitelabel: false, + writeUnitTests: false, + generateOauthClients: false, + generatePaginatedClients: false, + license + } as FernGeneratorExec.GeneratorConfig; + }; + + describe("github publishConfig with npm target", () => { + it("extracts packageName and version from github publishConfig with npm target", () => { + const config = createMockConfig(); + const publishConfig = FernIr.PublishingConfig.github({ + owner: "payabli", + repo: "sdk-node", + uri: undefined, + token: undefined, + mode: undefined, + branch: undefined, + target: FernIr.PublishTarget.npm({ + packageName: "@payabli/sdk-node", + version: "0.0.116", + tokenEnvironmentVariable: "NPM_TOKEN" + }) + }); + + const result = npmPackageInfoFromPublishConfig(config, publishConfig, false); + + expect(result.packageName).toBe("@payabli/sdk-node"); + expect(result.version).toBe("0.0.116"); + expect(result.repoUrl).toBe("github:payabli/sdk-node"); + expect(result.publishInfo).toBeUndefined(); + expect(result.isPackagePrivate).toBe(false); + }); + + it("uses uri as fallback when owner/repo are null", () => { + const config = createMockConfig(); + // Note: The GithubPublish type requires owner and repo as strings, + // but the code checks for != null, so we test with the uri fallback + // by providing a uri and checking that owner/repo take precedence when present + const publishConfig = FernIr.PublishingConfig.github({ + owner: "custom", + repo: "repo", + uri: "https://github.com/fallback/uri", + token: undefined, + mode: undefined, + branch: undefined, + target: FernIr.PublishTarget.npm({ + packageName: "@custom/sdk", + version: "1.0.0", + tokenEnvironmentVariable: "NPM_TOKEN" + }) + }); + + const result = npmPackageInfoFromPublishConfig(config, publishConfig, false); + + expect(result.packageName).toBe("@custom/sdk"); + expect(result.version).toBe("1.0.0"); + // owner/repo take precedence over uri + expect(result.repoUrl).toBe("github:custom/repo"); + }); + + it("preserves license config", () => { + const license = FernGeneratorExec.LicenseConfig.basic({ + id: "MIT" + }); + const config = createMockConfig(license); + const publishConfig = FernIr.PublishingConfig.github({ + owner: "test", + repo: "repo", + uri: undefined, + token: undefined, + mode: undefined, + branch: undefined, + target: FernIr.PublishTarget.npm({ + packageName: "@test/sdk", + version: "1.0.0", + tokenEnvironmentVariable: "NPM_TOKEN" + }) + }); + + const result = npmPackageInfoFromPublishConfig(config, publishConfig, false); + + expect(result.licenseConfig).toBe(license); + }); + }); + + describe("filesystem publishConfig with npm publishTarget", () => { + it("extracts packageName and version from filesystem publishConfig with npm publishTarget", () => { + const config = createMockConfig(); + const publishConfig = FernIr.PublishingConfig.filesystem({ + generateFullProject: true, + publishTarget: FernIr.PublishTarget.npm({ + packageName: "@payabli/sdk-node", + version: "0.0.116", + tokenEnvironmentVariable: "NPM_TOKEN" + }) + }); + + const result = npmPackageInfoFromPublishConfig(config, publishConfig, false); + + expect(result.packageName).toBe("@payabli/sdk-node"); + expect(result.version).toBe("0.0.116"); + expect(result.repoUrl).toBeUndefined(); + expect(result.publishInfo).toBeUndefined(); + expect(result.isPackagePrivate).toBe(false); + }); + + it("handles filesystem publishConfig without publishTarget", () => { + const config = createMockConfig(); + const publishConfig = FernIr.PublishingConfig.filesystem({ + generateFullProject: true, + publishTarget: undefined + }); + + const result = npmPackageInfoFromPublishConfig(config, publishConfig, false); + + expect(result.packageName).toBeUndefined(); + expect(result.version).toBeUndefined(); + expect(result.isPackagePrivate).toBe(false); + }); + }); + + describe("direct publishConfig with npm target", () => { + it("extracts packageName and version from direct publishConfig with npm target", () => { + const config = createMockConfig(); + const publishConfig = FernIr.PublishingConfig.direct({ + target: FernIr.PublishTarget.npm({ + packageName: "@direct/sdk", + version: "2.0.0", + tokenEnvironmentVariable: "NPM_TOKEN" + }) + }); + + const result = npmPackageInfoFromPublishConfig(config, publishConfig, true); + + expect(result.packageName).toBe("@direct/sdk"); + expect(result.version).toBe("2.0.0"); + expect(result.repoUrl).toBeUndefined(); + expect(result.publishInfo).toBeUndefined(); + expect(result.isPackagePrivate).toBe(true); + }); + }); + + describe("non-npm publish targets", () => { + it("returns empty args for maven target", () => { + const config = createMockConfig(); + const publishConfig = FernIr.PublishingConfig.filesystem({ + generateFullProject: true, + publishTarget: FernIr.PublishTarget.maven({ + coordinate: "com.example:sdk", + version: "1.0.0", + usernameEnvironmentVariable: "MAVEN_USERNAME", + passwordEnvironmentVariable: "MAVEN_PASSWORD", + mavenUrlEnvironmentVariable: "MAVEN_URL" + }) + }); + + const result = npmPackageInfoFromPublishConfig(config, publishConfig, false); + + expect(result.packageName).toBeUndefined(); + expect(result.version).toBeUndefined(); + expect(result.isPackagePrivate).toBe(false); + }); + + it("returns empty args for pypi target", () => { + const config = createMockConfig(); + const publishConfig = FernIr.PublishingConfig.github({ + owner: "test", + repo: "repo", + uri: undefined, + token: undefined, + mode: undefined, + branch: undefined, + target: FernIr.PublishTarget.pypi({ + packageName: "test-sdk", + version: "1.0.0" + }) + }); + + const result = npmPackageInfoFromPublishConfig(config, publishConfig, false); + + expect(result.packageName).toBeUndefined(); + expect(result.version).toBeUndefined(); + expect(result.isPackagePrivate).toBe(false); + }); + }); + + describe("undefined publishConfig", () => { + it("returns only isPackagePrivate when publishConfig is undefined", () => { + const config = createMockConfig(); + + const result = npmPackageInfoFromPublishConfig(config, undefined, true); + + expect(result.packageName).toBeUndefined(); + expect(result.version).toBeUndefined(); + expect(result.repoUrl).toBeUndefined(); + expect(result.publishInfo).toBeUndefined(); + expect(result.isPackagePrivate).toBe(true); + }); + }); + + describe("isPackagePrivate flag", () => { + it("sets isPackagePrivate to true when specified", () => { + const config = createMockConfig(); + const publishConfig = FernIr.PublishingConfig.filesystem({ + generateFullProject: true, + publishTarget: FernIr.PublishTarget.npm({ + packageName: "@private/sdk", + version: "1.0.0", + tokenEnvironmentVariable: "NPM_TOKEN" + }) + }); + + const result = npmPackageInfoFromPublishConfig(config, publishConfig, true); + + expect(result.isPackagePrivate).toBe(true); + }); + + it("sets isPackagePrivate to false when specified", () => { + const config = createMockConfig(); + const publishConfig = FernIr.PublishingConfig.filesystem({ + generateFullProject: true, + publishTarget: FernIr.PublishTarget.npm({ + packageName: "@public/sdk", + version: "1.0.0", + tokenEnvironmentVariable: "NPM_TOKEN" + }) + }); + + const result = npmPackageInfoFromPublishConfig(config, publishConfig, false); + + expect(result.isPackagePrivate).toBe(false); + }); + }); +}); diff --git a/generators/typescript/utils/abstract-generator-cli/src/npmPackageInfoFromPublishConfig.ts b/generators/typescript/utils/abstract-generator-cli/src/npmPackageInfoFromPublishConfig.ts new file mode 100644 index 000000000000..77fe32dc391b --- /dev/null +++ b/generators/typescript/utils/abstract-generator-cli/src/npmPackageInfoFromPublishConfig.ts @@ -0,0 +1,57 @@ +import { FernGeneratorExec } from "@fern-api/base-generator"; +import { FernIr } from "@fern-fern/ir-sdk"; +import { constructNpmPackageArgs, getRepoUrlFromUrl } from "@fern-typescript/commons"; + +/** + * Extracts npm package info from the IR's publishConfig. + * This is used as a fallback when constructNpmPackage returns undefined + * (e.g., in downloadFiles mode) to preserve package.json metadata. + * + * Handles all three publishConfig types: + * - github: Uses target.type === "npm" and constructs repoUrl from owner/repo + * - direct: Uses target.type === "npm" (no repoUrl) + * - filesystem: Uses publishTarget.type === "npm" (no repoUrl) + */ +export function npmPackageInfoFromPublishConfig( + config: FernGeneratorExec.GeneratorConfig, + publishConfig: FernIr.PublishingConfig | undefined, + isPackagePrivate: boolean +): constructNpmPackageArgs { + let args = {}; + if (publishConfig?.type === "github" || publishConfig?.type === "direct" || publishConfig?.type === "filesystem") { + const target = publishConfig?.type === "filesystem" ? publishConfig.publishTarget : publishConfig.target; + if (target?.type === "npm") { + args = { + packageName: target.packageName, + version: target.version, + repoUrl: getRepoUrl(publishConfig), + publishInfo: undefined, + licenseConfig: config.license + }; + } + } + return { + ...args, + isPackagePrivate + }; +} + +function getRepoUrl( + publishConfig: FernIr.PublishingConfig.Github | FernIr.PublishingConfig.Direct | FernIr.PublishingConfig.Filesystem +): string | undefined { + const url = publishConfig._visit({ + github: (value) => { + if (value.owner != null && value.repo != null) { + return `https://github.com/${value.owner}/${value.repo}`; + } + return value.uri; + }, + direct: () => undefined, + filesystem: () => undefined, + _other: () => undefined + }); + if (!url) { + return undefined; + } + return getRepoUrlFromUrl(url); +} From 64baf36001bde3edd29f4924dba5c187630fb353 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Fri, 12 Dec 2025 05:46:44 +0000 Subject: [PATCH 5/5] fix(typescript): Remove invalid branch property from GithubPublish test objects Co-Authored-By: Niels Swimberghe <3382717+Swimburger@users.noreply.github.com> --- .../src/__test__/npmPackageInfoFromPublishConfig.test.ts | 4 ---- 1 file changed, 4 deletions(-) diff --git a/generators/typescript/utils/abstract-generator-cli/src/__test__/npmPackageInfoFromPublishConfig.test.ts b/generators/typescript/utils/abstract-generator-cli/src/__test__/npmPackageInfoFromPublishConfig.test.ts index 3dc5576f37f9..682c2e154479 100644 --- a/generators/typescript/utils/abstract-generator-cli/src/__test__/npmPackageInfoFromPublishConfig.test.ts +++ b/generators/typescript/utils/abstract-generator-cli/src/__test__/npmPackageInfoFromPublishConfig.test.ts @@ -35,7 +35,6 @@ describe("npmPackageInfoFromPublishConfig", () => { uri: undefined, token: undefined, mode: undefined, - branch: undefined, target: FernIr.PublishTarget.npm({ packageName: "@payabli/sdk-node", version: "0.0.116", @@ -63,7 +62,6 @@ describe("npmPackageInfoFromPublishConfig", () => { uri: "https://github.com/fallback/uri", token: undefined, mode: undefined, - branch: undefined, target: FernIr.PublishTarget.npm({ packageName: "@custom/sdk", version: "1.0.0", @@ -90,7 +88,6 @@ describe("npmPackageInfoFromPublishConfig", () => { uri: undefined, token: undefined, mode: undefined, - branch: undefined, target: FernIr.PublishTarget.npm({ packageName: "@test/sdk", version: "1.0.0", @@ -190,7 +187,6 @@ describe("npmPackageInfoFromPublishConfig", () => { uri: undefined, token: undefined, mode: undefined, - branch: undefined, target: FernIr.PublishTarget.pypi({ packageName: "test-sdk", version: "1.0.0"