diff --git a/generators/typescript/sdk/CHANGELOG.md b/generators/typescript/sdk/CHANGELOG.md index feb57a6f84d..673fc489bf7 100644 --- a/generators/typescript/sdk/CHANGELOG.md +++ b/generators/typescript/sdk/CHANGELOG.md @@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.32.0] - 2024-07-15 + +- Feature: The `reference.md` is now generated for every SDK. +- Improvement: The `reference.md` is now generated by the `generator-cli`. +- Fix: The `reference.md` includes a single section for the _first_ example specified + on the endpoint. Previously, a separate section was included for _every_ example. + ## [0.31.0] - 2024-07-12 - Feature: Add `omitUndefined` generator option. This is enabled with the following config: diff --git a/generators/typescript/sdk/VERSION b/generators/typescript/sdk/VERSION index 26bea73e811..9eb2aa3f109 100644 --- a/generators/typescript/sdk/VERSION +++ b/generators/typescript/sdk/VERSION @@ -1 +1 @@ -0.31.0 +0.32.0 diff --git a/generators/typescript/sdk/cli/src/SdkGeneratorCli.ts b/generators/typescript/sdk/cli/src/SdkGeneratorCli.ts index 9d3d30673c0..9d52819318e 100644 --- a/generators/typescript/sdk/cli/src/SdkGeneratorCli.ts +++ b/generators/typescript/sdk/cli/src/SdkGeneratorCli.ts @@ -124,7 +124,6 @@ export class SdkGeneratorCli extends AbstractGeneratorCli { includeSerdeLayer: !customConfig.noSerdeLayer, retainOriginalCasing: customConfig.retainOriginalCasing ?? false, noOptionalProperties: customConfig.noOptionalProperties, - includeApiReference: customConfig.includeApiReference ?? false, tolerateRepublish: customConfig.tolerateRepublish, allowExtraFields: customConfig.allowExtraFields ?? false, inlineFileProperties: customConfig.inlineFileProperties ?? false, diff --git a/generators/typescript/sdk/cli/src/custom-config/schema/SdkCustomConfigSchema.ts b/generators/typescript/sdk/cli/src/custom-config/schema/SdkCustomConfigSchema.ts index 1ff5f4d2f2c..d2bb3d752eb 100644 --- a/generators/typescript/sdk/cli/src/custom-config/schema/SdkCustomConfigSchema.ts +++ b/generators/typescript/sdk/cli/src/custom-config/schema/SdkCustomConfigSchema.ts @@ -29,13 +29,13 @@ export const SdkCustomConfigSchema = z.strictObject({ includeContentHeadersOnFileDownloadResponse: z.optional(z.boolean()), includeUtilsOnUnionMembers: z.optional(z.boolean()), includeOtherInUnionTypes: z.optional(z.boolean()), - includeApiReference: z.optional(z.boolean()), retainOriginalCasing: z.optional(z.boolean()), allowExtraFields: z.optional(z.boolean()), inlineFileProperties: z.optional(z.boolean()), // deprecated - timeoutInSeconds: z.optional(z.union([z.literal("infinity"), z.number()])) + timeoutInSeconds: z.optional(z.union([z.literal("infinity"), z.number()])), + includeApiReference: z.optional(z.boolean()) }); export type SdkCustomConfigSchema = z.infer; diff --git a/generators/typescript/sdk/generator/src/ReferenceGenerator.ts b/generators/typescript/sdk/generator/src/ReferenceGenerator.ts deleted file mode 100644 index 11db7406e75..00000000000 --- a/generators/typescript/sdk/generator/src/ReferenceGenerator.ts +++ /dev/null @@ -1,137 +0,0 @@ -export declare namespace ReferenceGenerator { - export interface Init { - apiName: string; - } -} -export declare namespace ReferenceGeneratorSection { - export interface Init { - apiName: string; - // Heading is essentially just the endpoint name in the root package OR - heading: string; - } -} - -export interface ReferenceParameterDeclaration { - name: string; - type: string; - typePath?: string; - description?: string; -} -export interface EndpointDeclaration { - functionPath?: string; - functionName: string; - clientPath?: string; - returnType: string | undefined; - returnTypePath?: string; - codeSnippet: string | undefined; - parameters: ReferenceParameterDeclaration[]; - description?: string; -} - -function writeIndentedBlock(content: string): string { - return `
\n\n
\n\n${content}\n\n
\n\n
`; -} - -function wrapInLink(content: string, link?: string) { - return link !== undefined ? `${content}` : content; -} - -function writeSignature(parameters: ReferenceParameterDeclaration[]): string { - return `(${parameters - .filter((param) => param.name !== "requestOptions") - .map((param) => (param.name === "request" ? "{ ...params }" : param.name)) - .join(", ")})`; -} - -class ReferenceGeneratorSection { - apiName: string; - heading: string; - endpoints: EndpointDeclaration[]; - - constructor(init: ReferenceGeneratorSection.Init) { - this.apiName = init.apiName; - this.heading = init.heading; - this.endpoints = []; - } - - public addEndpoint(endpoint: EndpointDeclaration): void { - this.endpoints.push(endpoint); - } - - private writeParameter(parameter: ReferenceParameterDeclaration): string { - const desc = parameter.description?.match(/[^\r\n]+/g)?.length; - const containsLineBreak = desc !== undefined && desc > 1; - return ` -**${parameter.name}: \`${wrapInLink(parameter.type, parameter.typePath)}\`** ${ - parameter.description !== undefined ? (containsLineBreak ? "\n\n" : "— ") + parameter.description : "" - } -`; - } - - private writeEndpoint(endpoint: EndpointDeclaration): string { - const descriptionBlock = - endpoint.description !== undefined - ? `#### 📝 Description\n\n${writeIndentedBlock(writeIndentedBlock(endpoint.description))}\n\n` - : ""; - const usageBlock = - endpoint.codeSnippet !== undefined - ? `#### 🔌 Usage\n\n${writeIndentedBlock( - writeIndentedBlock("```ts\n" + endpoint.codeSnippet + "```") - )}\n\n` - : ""; - const parametersBlock = - endpoint.parameters.length > 0 - ? `#### ⚙️ Parameters\n\n${writeIndentedBlock( - endpoint.parameters - .map((parameter) => writeIndentedBlock(this.writeParameter(parameter))) - .join("\n\n") - )}\n\n` - : ""; - - return ` -
${endpoint.clientPath ?? this.apiName}.${wrapInLink( - endpoint.functionName, - endpoint.functionPath - )}${writeSignature(endpoint.parameters)} -> ${wrapInLink( - endpoint.returnType === undefined ? "void" : endpoint.returnType, - endpoint.returnTypePath - )} - -${writeIndentedBlock(descriptionBlock + usageBlock + parametersBlock)} -
-`; - } - - write(): string { - return ` -## ${this.heading} - -${this.endpoints.map((endpoint) => this.writeEndpoint(endpoint)).join("\n")} - -`; - } -} - -export class ReferenceGenerator { - apiName: string; - sections: ReferenceGeneratorSection[]; - - constructor(init: ReferenceGenerator.Init) { - this.apiName = init.apiName; - this.apiName = init.apiName; - this.sections = []; - } - - public addSection(heading: string): ReferenceGeneratorSection { - const section = new ReferenceGeneratorSection({ apiName: this.apiName, heading }); - this.sections.push(section); - return section; - } - - public write(): string { - return this.sections - .filter((section) => section.heading.length > 0) - .map((section) => section.write()) - .join("\n"); - } -} diff --git a/generators/typescript/sdk/generator/src/SdkGenerator.ts b/generators/typescript/sdk/generator/src/SdkGenerator.ts index bdcf5666f95..3a1dc9aad91 100644 --- a/generators/typescript/sdk/generator/src/SdkGenerator.ts +++ b/generators/typescript/sdk/generator/src/SdkGenerator.ts @@ -1,4 +1,5 @@ import { AbsoluteFilePath, RelativeFilePath } from "@fern-api/fs-utils"; +import { FernGeneratorCli } from "@fern-fern/generator-cli-sdk"; import { FernGeneratorExec } from "@fern-fern/generator-exec-sdk"; import * as FernGeneratorExecSerializers from "@fern-fern/generator-exec-sdk/serialization"; import { @@ -55,7 +56,8 @@ import { SdkInlinedRequestBodyDeclarationReferencer } from "./declaration-refere import { TimeoutSdkErrorDeclarationReferencer } from "./declaration-referencers/TimeoutSdkErrorDeclarationReferencer"; import { TypeDeclarationReferencer } from "./declaration-referencers/TypeDeclarationReferencer"; import { GeneratorCli } from "./generator-cli/Client"; -import { ReferenceGenerator, ReferenceParameterDeclaration } from "./ReferenceGenerator"; +import { ReadmeGenerator } from "./generator-cli/ReadmeGenerator"; +import { ReferenceGenerator } from "./generator-cli/ReferenceGenerator"; import { TemplateGenerator } from "./TemplateGenerator"; import { JestTestGenerator } from "./test-generator/JestTestGenerator"; @@ -107,7 +109,6 @@ export declare namespace SdkGenerator { includeContentHeadersOnFileDownloadResponse: boolean; includeSerdeLayer: boolean; noOptionalProperties: boolean; - includeApiReference: boolean; tolerateRepublish: boolean; retainOriginalCasing: boolean; allowExtraFields: boolean; @@ -175,6 +176,8 @@ export class SdkGenerator { private oauthTokenProviderGenerator: OAuthTokenProviderGenerator; private jestTestGenerator: JestTestGenerator; private generatorCli: GeneratorCli; + private readmeGenerator: ReadmeGenerator; + private refGenerator: ReferenceGenerator; private FdrClient: FdrSnippetTemplateClient | undefined; constructor({ @@ -349,10 +352,14 @@ export class SdkGenerator { this.config.writeUnitTests ); this.generatorCli = new GeneratorCli({ - logger: context.logger, - organization: config.organization, - intermediateRepresentation, - npmPackage + logger: context.logger + }); + this.readmeGenerator = new ReadmeGenerator({ + generatorCli: this.generatorCli, + logger: context.logger + }); + this.refGenerator = new ReferenceGenerator({ + generatorCli: this.generatorCli }); this.FdrClient = @@ -423,13 +430,7 @@ export class SdkGenerator { } if (this.config.snippetFilepath != null) { - let refGenerator: ReferenceGenerator | undefined; - if (this.config.includeApiReference) { - refGenerator = new ReferenceGenerator({ - apiName: this.namespaceExport === "api" ? "client" : this.namespaceExport - }); - } - this.generateSnippets({ refGenerator }); + this.generateSnippets(); const snippets: FernGeneratorExec.Snippets = { endpoints: this.endpointSnippets, types: {} @@ -464,9 +465,6 @@ export class SdkGenerator { } } } - if (this.config.includeApiReference && refGenerator !== undefined) { - this.extraFiles["reference.md"] = refGenerator.write(); - } this.context.logger.debug("Generated snippets"); try { @@ -474,6 +472,12 @@ export class SdkGenerator { } catch (e) { this.context.logger.warn("Failed to generate README.md, this is OK"); } + + try { + await this.generateReference(); + } catch (e) { + this.context.logger.warn("Failed to generate reference.md, this is OK"); + } } return this.config.shouldBundle @@ -705,13 +709,15 @@ export class SdkGenerator { return; } await this.withRawFile({ - filepath: this.generatorCli.getReadmeExportedFilePath(), + filepath: this.readmeGenerator.getExportedFilePath(), run: async ({ sourceFile, importsManager }) => { const context = this.generateSdkContext({ sourceFile, importsManager }); - const readmeContent = await this.generatorCli.generateReadme({ + const readmeContent = await this.readmeGenerator.generateReadme({ context, + ir: this.intermediateRepresentation, + organization: this.config.organization, + npmPackage: this.npmPackage, endpointSnippets: this.endpointSnippets, - originalReadmeFilepath: this.config.originalReadmeFilepath, githubRepoUrl: this.config.githubRepoUrl, githubInstallationToken: this.config.githubInstallationToken }); @@ -720,6 +726,20 @@ export class SdkGenerator { }); } + private async generateReference(): Promise { + if (this.refGenerator.isEmpty()) { + // Don't generate a reference.md if there aren't any sections. + return; + } + await this.withRawFile({ + filepath: this.refGenerator.getExportedFilePath(), + run: async ({ sourceFile }) => { + const referenceContent = await this.refGenerator.generateReference(); + sourceFile.replaceWithText(referenceContent); + } + }); + } + private runWithSnippet({ sourceFile, importsManager, @@ -770,25 +790,24 @@ export class SdkGenerator { return [ts.factory.createExpressionStatement(endpointInvocation)]; } - private generateSnippets({ refGenerator }: { refGenerator: ReferenceGenerator | undefined }) { + private generateSnippets() { const rootPackage: PackageId = { isRoot: true }; this.forEachService((service, packageId) => { if (service.endpoints.length === 0) { return; } - let serviceReference = refGenerator?.addSection( - service.displayName ?? + let serviceReference = this.refGenerator.addSection({ + title: + service.displayName ?? service.name.fernFilepath.allParts.map((part) => part.pascalCase.unsafeName).join(" ") - ); + }); const exportedFilepath = this.sdkClientClassDeclarationReferencer.getExportedFilepath(packageId); const serviceFilepath = convertExportedFilePathToFilePath(exportedFilepath); for (const endpoint of service.endpoints) { if (packageId.isRoot) { - serviceReference = refGenerator?.addSection( - endpoint.displayName ?? endpoint.name.pascalCase.unsafeName - ); + serviceReference = this.refGenerator.addRootSection(); } if (this.config.snippetTemplateFilepath != null && this.npmPackage != null) { @@ -855,7 +874,7 @@ export class SdkGenerator { examplesForEndpoint = maybeAutogeneratedExample != null ? [maybeAutogeneratedExample] : []; } - for (const example of examplesForEndpoint) { + for (const [index, example] of examplesForEndpoint.entries()) { const snippet = this.withSnippet({ run: ({ sourceFile, importsManager }): ts.Node[] | undefined => { return this.runWithSnippet({ @@ -889,10 +908,11 @@ export class SdkGenerator { this.endpointSnippets.push(endpointSnippet); } - if (serviceReference !== undefined) { + if (index === 0 && serviceReference != null) { + // We only include a reference section for the first example. let returnType = undefined; let endpointClientAccess: ts.Expression | undefined = undefined; - const parameters: ReferenceParameterDeclaration[] = []; + const parameters: FernGeneratorCli.ParameterReference[] = []; const referenceSnippet = this.withSnippet({ run: ({ sourceFile, importsManager }): ts.Node[] | undefined => { const context = this.generateSdkContext( @@ -911,8 +931,9 @@ export class SdkGenerator { ...(endpointDetailed?.getSignature(context).parameters.map((param) => { return { name: param.name, + description: param.docs, type: param.type?.toString() ?? "unknown", - description: param.docs + required: param.hasQuestionToken != null ? !param.hasQuestionToken : true }; }) ?? []) ); @@ -937,19 +958,40 @@ export class SdkGenerator { let statement = undefined; // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition if (endpointClientAccess !== undefined) { - statement = getTextOfTsNode(endpointClientAccess); + statement = getTextOfTsNode(endpointClientAccess) + "."; } - serviceReference.addEndpoint({ - // clientPath: getTextOfTsNode(statement), - clientPath: statement, - functionPath: serviceFilepath, - functionName: this.getEndpointFunctionName(endpoint), - returnType, - parameters, - codeSnippet: referenceSnippet, - description: endpoint.docs - }); + if (referenceSnippet != null && statement != null) { + serviceReference.addEndpoint({ + title: { + snippetParts: [ + { + text: statement + }, + { + text: this.getEndpointFunctionName(endpoint), + location: { + path: serviceFilepath + } + }, + { + text: this.getReferenceEndpointInvocationParameters({ + parameters + }) + } + ], + returnValue: + returnType != null + ? { + text: returnType + } + : undefined + }, + description: endpoint.docs, + snippet: referenceSnippet, + parameters + }); + } } } } @@ -960,6 +1002,17 @@ export class SdkGenerator { return endpoint.name.camelCase.unsafeName; } + private getReferenceEndpointInvocationParameters({ + parameters + }: { + parameters: FernGeneratorCli.ParameterReference[]; + }): string { + return `(${parameters + .filter((param) => param.name !== "requestOptions") + .map((param) => (param.name === "request" ? "{ ...params }" : param.name)) + .join(", ")})`; + } + // TODO(dsinghvi): HACKHACK Move this to IR private getFullPathForEndpoint(endpoint: HttpEndpoint): string { let url = ""; diff --git a/generators/typescript/sdk/generator/src/generator-cli/Client.ts b/generators/typescript/sdk/generator/src/generator-cli/Client.ts index b555bf3ff11..900d841d810 100644 --- a/generators/typescript/sdk/generator/src/generator-cli/Client.ts +++ b/generators/typescript/sdk/generator/src/generator-cli/Client.ts @@ -2,153 +2,65 @@ import { AbsoluteFilePath } from "@fern-api/fs-utils"; import { Logger } from "@fern-api/logger"; import { createLoggingExecutable, LoggingExecutable } from "@fern-api/logging-execa"; import { FernGeneratorCli } from "@fern-fern/generator-cli-sdk"; -import { FernGeneratorExec } from "@fern-fern/generator-exec-sdk"; -import { IntermediateRepresentation } from "@fern-fern/ir-sdk/api"; -import { ExportedFilePath, NpmPackage } from "@fern-typescript/commons"; -import { SdkContext } from "@fern-typescript/contexts"; -import { readFile, writeFile } from "fs/promises"; -import yaml from "js-yaml"; -import path from "path"; +import { writeFile } from "fs/promises"; import tmp from "tmp-promise"; -import { ReadmeSnippetBuilder } from "./ReadmeSnippetBuilder"; -const README_FILENAME = "README.md"; const GENERATOR_CLI_NPM_PACKAGE = "@fern-api/generator-cli"; -const DOCKER_FEATURES_CONFIG_PATH = "/assets/features.yml"; export class GeneratorCli { private logger: Logger; - private organization: string; - private ir: IntermediateRepresentation; - private npmPackage: NpmPackage | undefined; private skipInstall: boolean; private generatorCli: LoggingExecutable | undefined; - constructor({ - logger, - organization, - intermediateRepresentation, - npmPackage, - skipInstall - }: { - logger: Logger; - organization: string; - intermediateRepresentation: IntermediateRepresentation; - npmPackage: NpmPackage | undefined; - skipInstall?: boolean; - }) { + constructor({ logger, skipInstall }: { logger: Logger; skipInstall?: boolean }) { this.logger = logger; - this.organization = organization; - this.ir = intermediateRepresentation; - this.npmPackage = npmPackage; this.skipInstall = skipInstall ?? false; } - public getReadmeExportedFilePath(): ExportedFilePath { - return { - directories: [], - file: { - nameOnDisk: README_FILENAME - }, - rootDir: "" - }; - } - - public async generateReadme({ - context, - endpointSnippets, - originalReadmeFilepath, - githubRepoUrl, - githubInstallationToken + public async generateReference({ + referenceConfig }: { - context: SdkContext; - endpointSnippets: FernGeneratorExec.Endpoint[]; - originalReadmeFilepath: string | undefined; - githubRepoUrl: string | undefined; - githubInstallationToken: string | undefined; + referenceConfig: FernGeneratorCli.ReferenceConfig; }): Promise { - const readmeSnippetBuilder = new ReadmeSnippetBuilder({ - context, - readmeConfig: this.ir.readmeConfig, - npmPackage: this.npmPackage, - services: this.ir.services, - endpointSnippets + const referenceConfigFilepath = await this.writeReferenceConfig({ + referenceConfig }); + const args = ["generate-reference", "--config", referenceConfigFilepath]; + const generatorCli = await this.getOrInstall(); + const content = await generatorCli(args); + return content.stdout; + } + + private async writeReferenceConfig({ + referenceConfig + }: { + referenceConfig: FernGeneratorCli.ReferenceConfig; + }): Promise { + const referenceConfigFile = await tmp.file(); + await writeFile(referenceConfigFile.path, JSON.stringify(referenceConfig)); + return AbsoluteFilePath.of(referenceConfigFile.path); + } + + public async generateReadme({ readmeConfig }: { readmeConfig: FernGeneratorCli.ReadmeConfig }): Promise { const readmeConfigFilepath = await this.writeReadmeConfig({ - snippets: readmeSnippetBuilder.buildReadmeSnippets(), - githubRepoUrl, - githubInstallationToken + readmeConfig }); const args = ["generate", "readme", "--config", readmeConfigFilepath]; - if (originalReadmeFilepath) { - args.push("--original-readme", originalReadmeFilepath); - } const generatorCli = await this.getOrInstall(); const content = await generatorCli(args); return content.stdout; } private async writeReadmeConfig({ - snippets, - githubRepoUrl, - githubInstallationToken + readmeConfig }: { - snippets: Record; - githubRepoUrl: string | undefined; - githubInstallationToken: string | undefined; + readmeConfig: FernGeneratorCli.ReadmeConfig; }): Promise { - const readmeConfig = await this.getReadmeConfig({ snippets, githubRepoUrl, githubInstallationToken }); const readmeConfigFile = await tmp.file(); await writeFile(readmeConfigFile.path, JSON.stringify(readmeConfig)); return AbsoluteFilePath.of(readmeConfigFile.path); } - private async getReadmeConfig({ - snippets, - githubRepoUrl, - githubInstallationToken - }: { - snippets: Record; - githubRepoUrl: string | undefined; - githubInstallationToken: string | undefined; - }): Promise { - const featureConfig = await this.readFeatureConfig(); - const features: FernGeneratorCli.ReadmeFeature[] = []; - for (const feature of featureConfig.features) { - const featureSnippets = snippets[feature.id]; - if (!featureSnippets) { - continue; - } - features.push({ - id: feature.id, - advanced: feature.advanced, - description: feature.description, - snippets: featureSnippets, - snippetsAreOptional: false - }); - } - return { - remote: this.getRemote({ - githubRepoUrl, - githubInstallationToken - }), - language: this.getLanguageInfo(), - organization: this.organization, - apiReferenceLink: this.ir.readmeConfig?.apiReferenceLink, - bannerLink: this.ir.readmeConfig?.bannerLink, - features - }; - } - - private async readFeatureConfig(): Promise { - this.logger.debug("Reading feature configuration ..."); - const rawContents = await readFile(getFeaturesConfigPath(), "utf8"); - if (rawContents.length === 0) { - throw new Error("Internal error; failed to read feature configuration"); - } - return yaml.load(rawContents) as FernGeneratorCli.FeatureConfig; - } - private async getOrInstall(): Promise { if (this.generatorCli) { return this.generatorCli; @@ -181,38 +93,4 @@ export class GeneratorCli { this.generatorCli = generatorCli; return generatorCli; } - - private getRemote({ - githubRepoUrl, - githubInstallationToken - }: { - githubRepoUrl: string | undefined; - githubInstallationToken: string | undefined; - }): FernGeneratorCli.Remote | undefined { - if (githubRepoUrl != null && githubInstallationToken != null) { - return FernGeneratorCli.Remote.github({ - repoUrl: githubRepoUrl, - installationToken: githubInstallationToken - }); - } - return undefined; - } - - private getLanguageInfo(): FernGeneratorCli.LanguageInfo { - if (this.npmPackage != null) { - return FernGeneratorCli.LanguageInfo.typescript({ - publishInfo: { - packageName: this.npmPackage.packageName - } - }); - } - return FernGeneratorCli.LanguageInfo.typescript({}); - } -} - -function getFeaturesConfigPath(): string { - if (process.env.NODE_ENV === "test") { - return path.join(__dirname, "../../features.yml"); - } - return DOCKER_FEATURES_CONFIG_PATH; } diff --git a/generators/typescript/sdk/generator/src/generator-cli/ReadmeGenerator.ts b/generators/typescript/sdk/generator/src/generator-cli/ReadmeGenerator.ts new file mode 100644 index 00000000000..70d73169de0 --- /dev/null +++ b/generators/typescript/sdk/generator/src/generator-cli/ReadmeGenerator.ts @@ -0,0 +1,155 @@ +import { Logger } from "@fern-api/logger"; +import { FernGeneratorCli } from "@fern-fern/generator-cli-sdk"; +import { FernGeneratorExec } from "@fern-fern/generator-exec-sdk"; +import { IntermediateRepresentation } from "@fern-fern/ir-sdk/api"; +import { ExportedFilePath, NpmPackage } from "@fern-typescript/commons"; +import { SdkContext } from "@fern-typescript/contexts"; +import { readFile } from "fs/promises"; +import yaml from "js-yaml"; +import path from "path"; +import { GeneratorCli } from "./Client"; +import { ReadmeSnippetBuilder } from "./ReadmeSnippetBuilder"; + +const DOCKER_FEATURES_CONFIG_PATH = "/assets/features.yml"; +const README_FILENAME = "README.md"; + +export class ReadmeGenerator { + private generatorCli: GeneratorCli; + private logger: Logger; + + constructor({ generatorCli, logger }: { generatorCli: GeneratorCli; logger: Logger }) { + this.generatorCli = generatorCli; + this.logger = logger; + } + + public getExportedFilePath(): ExportedFilePath { + return { + directories: [], + file: { + nameOnDisk: README_FILENAME + }, + rootDir: "" + }; + } + + public async generateReadme({ + context, + ir, + organization, + endpointSnippets, + npmPackage, + githubRepoUrl, + githubInstallationToken + }: { + context: SdkContext; + ir: IntermediateRepresentation; + organization: string; + endpointSnippets: FernGeneratorExec.Endpoint[]; + npmPackage: NpmPackage | undefined; + githubRepoUrl: string | undefined; + githubInstallationToken: string | undefined; + }): Promise { + const readmeSnippetBuilder = new ReadmeSnippetBuilder({ + context, + readmeConfig: ir.readmeConfig, + npmPackage, + services: ir.services, + endpointSnippets + }); + const readmeConfig = await this.newReadmeConfig({ + ir, + organization, + snippets: readmeSnippetBuilder.buildReadmeSnippets(), + npmPackage, + githubRepoUrl, + githubInstallationToken + }); + return this.generatorCli.generateReadme({ readmeConfig }); + } + + private async newReadmeConfig({ + ir, + organization, + snippets, + npmPackage, + githubRepoUrl, + githubInstallationToken + }: { + ir: IntermediateRepresentation; + organization: string; + snippets: Record; + npmPackage: NpmPackage | undefined; + githubRepoUrl: string | undefined; + githubInstallationToken: string | undefined; + }): Promise { + const featureConfig = await this.readFeatureConfig(); + const features: FernGeneratorCli.ReadmeFeature[] = []; + for (const feature of featureConfig.features) { + const featureSnippets = snippets[feature.id]; + if (!featureSnippets) { + continue; + } + features.push({ + id: feature.id, + advanced: feature.advanced, + description: feature.description, + snippets: featureSnippets, + snippetsAreOptional: false + }); + } + return { + remote: this.getRemote({ + githubRepoUrl, + githubInstallationToken + }), + language: this.getLanguageInfo({ npmPackage }), + organization, + apiReferenceLink: ir.readmeConfig?.apiReferenceLink, + bannerLink: ir.readmeConfig?.bannerLink, + features + }; + } + + private async readFeatureConfig(): Promise { + this.logger.debug("Reading feature configuration ..."); + const rawContents = await readFile(getFeaturesConfigPath(), "utf8"); + if (rawContents.length === 0) { + throw new Error("Internal error; failed to read feature configuration"); + } + return yaml.load(rawContents) as FernGeneratorCli.FeatureConfig; + } + + private getRemote({ + githubRepoUrl, + githubInstallationToken + }: { + githubRepoUrl: string | undefined; + githubInstallationToken: string | undefined; + }): FernGeneratorCli.Remote | undefined { + if (githubRepoUrl != null && githubInstallationToken != null) { + return FernGeneratorCli.Remote.github({ + repoUrl: githubRepoUrl, + installationToken: githubInstallationToken + }); + } + return undefined; + } + + private getLanguageInfo({ npmPackage }: { npmPackage: NpmPackage | undefined }): FernGeneratorCli.LanguageInfo { + if (npmPackage != null) { + return FernGeneratorCli.LanguageInfo.typescript({ + publishInfo: { + packageName: npmPackage.packageName + } + }); + } + return FernGeneratorCli.LanguageInfo.typescript({}); + } +} + +function getFeaturesConfigPath(): string { + if (process.env.NODE_ENV === "test") { + return path.join(__dirname, "../../features.yml"); + } + return DOCKER_FEATURES_CONFIG_PATH; +} diff --git a/generators/typescript/sdk/generator/src/generator-cli/ReferenceGenerator.ts b/generators/typescript/sdk/generator/src/generator-cli/ReferenceGenerator.ts new file mode 100644 index 00000000000..9de476f6186 --- /dev/null +++ b/generators/typescript/sdk/generator/src/generator-cli/ReferenceGenerator.ts @@ -0,0 +1,69 @@ +import { FernGeneratorCli } from "@fern-fern/generator-cli-sdk"; +import { ExportedFilePath } from "@fern-typescript/commons"; +import { GeneratorCli } from "./Client"; + +const REFERENCE_FILENAME = "reference.md"; + +export class ReferenceGenerator { + private generatorCli: GeneratorCli; + private rootSection: FernGeneratorCli.RootPackageReferenceSection | undefined; + private sections: FernGeneratorCli.ReferenceSection[] = []; + + constructor({ generatorCli }: { generatorCli: GeneratorCli }) { + this.generatorCli = generatorCli; + } + + public getExportedFilePath(): ExportedFilePath { + return { + directories: [], + file: { + nameOnDisk: REFERENCE_FILENAME + }, + rootDir: "" + }; + } + + public isEmpty(): boolean { + return this.rootSection == null && this.sections.length === 0; + } + + public async generateReference(): Promise { + const referenceConfig: FernGeneratorCli.ReferenceConfig = { + rootSection: this.rootSection, + sections: this.sections, + language: FernGeneratorCli.Language.Typescript + }; + return this.generatorCli.generateReference({ referenceConfig }); + } + + public addRootSection(): ReferenceSectionBuilder { + const endpoints: FernGeneratorCli.EndpointReference[] = []; + this.rootSection = { + endpoints + }; + return new ReferenceSectionBuilder({ endpoints }); + } + + public addSection({ title, description }: { title: string; description?: string }): ReferenceSectionBuilder { + const endpoints: FernGeneratorCli.EndpointReference[] = []; + const section: FernGeneratorCli.ReferenceSection = { + title, + description, + endpoints + }; + this.sections.push(section); + return new ReferenceSectionBuilder({ endpoints }); + } +} + +export class ReferenceSectionBuilder { + private endpoints: FernGeneratorCli.EndpointReference[]; + + constructor({ endpoints }: { endpoints: FernGeneratorCli.EndpointReference[] }) { + this.endpoints = endpoints; + } + + public addEndpoint(endpoint: FernGeneratorCli.EndpointReference): void { + this.endpoints.push(endpoint); + } +} diff --git a/seed/ts-sdk/alias/reference.md b/seed/ts-sdk/alias/reference.md new file mode 100644 index 00000000000..6e5b88fdf69 --- /dev/null +++ b/seed/ts-sdk/alias/reference.md @@ -0,0 +1,51 @@ +# Reference + +
client.get(typeId) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.get("type-kaljhv87"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**typeId:** `SeedAlias.TypeId` + +
+
+ +
+
+ +**requestOptions:** `SeedAliasClient.RequestOptions` + +
+
+
+
+ +
+
+
+ +## diff --git a/seed/ts-sdk/api-wide-base-path/reference.md b/seed/ts-sdk/api-wide-base-path/reference.md new file mode 100644 index 00000000000..1db6ae5d5dc --- /dev/null +++ b/seed/ts-sdk/api-wide-base-path/reference.md @@ -0,0 +1,67 @@ +# Reference + +## Service + +
client.service.post(serviceParam, resourceParam, endpointParam) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.post("string", "string", 1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `string` + +
+
+ +
+
+ +**resourceParam:** `string` + +
+
+ +
+
+ +**endpointParam:** `number` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/audiences/reference.md b/seed/ts-sdk/audiences/reference.md new file mode 100644 index 00000000000..de683f9aaf3 --- /dev/null +++ b/seed/ts-sdk/audiences/reference.md @@ -0,0 +1,97 @@ +# Reference + +## FolderA Service + +
client.folderA.service.getDirectThread() -> SeedAudiences.Response +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.folderA.service.getDirectThread(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Foo + +
client.foo.find({ ...params }) -> SeedAudiences.ImportingType +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.foo.find({ + optionalString: "string", + publicProperty: "string", + privateProperty: 1, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedAudiences.FindRequest` + +
+
+ +
+
+ +**requestOptions:** `Foo.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/auth-environment-variables/reference.md b/seed/ts-sdk/auth-environment-variables/reference.md new file mode 100644 index 00000000000..d44ba5d435b --- /dev/null +++ b/seed/ts-sdk/auth-environment-variables/reference.md @@ -0,0 +1,123 @@ +# Reference + +## Service + +
client.service.getWithApiKey() -> string +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET request with custom api key + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.getWithApiKey(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.service.getWithHeader({ ...params }) -> string +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET request with custom api key + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.getWithHeader({ + xEndpointHeader: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedAuthEnvironmentVariables.HeaderAuthRequest` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/basic-auth-environment-variables/reference.md b/seed/ts-sdk/basic-auth-environment-variables/reference.md new file mode 100644 index 00000000000..c914e059783 --- /dev/null +++ b/seed/ts-sdk/basic-auth-environment-variables/reference.md @@ -0,0 +1,123 @@ +# Reference + +## BasicAuth + +
client.basicAuth.getWithBasicAuth() -> boolean +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET request with basic auth scheme + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.basicAuth.getWithBasicAuth(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `BasicAuth.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.basicAuth.postWithBasicAuth({ ...params }) -> boolean +
+
+ +#### 📝 Description + +
+
+ +
+
+ +POST request with basic auth scheme + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.basicAuth.postWithBasicAuth({ + key: "value", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `unknown` + +
+
+ +
+
+ +**requestOptions:** `BasicAuth.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/basic-auth/reference.md b/seed/ts-sdk/basic-auth/reference.md new file mode 100644 index 00000000000..c914e059783 --- /dev/null +++ b/seed/ts-sdk/basic-auth/reference.md @@ -0,0 +1,123 @@ +# Reference + +## BasicAuth + +
client.basicAuth.getWithBasicAuth() -> boolean +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET request with basic auth scheme + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.basicAuth.getWithBasicAuth(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `BasicAuth.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.basicAuth.postWithBasicAuth({ ...params }) -> boolean +
+
+ +#### 📝 Description + +
+
+ +
+
+ +POST request with basic auth scheme + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.basicAuth.postWithBasicAuth({ + key: "value", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `unknown` + +
+
+ +
+
+ +**requestOptions:** `BasicAuth.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/bearer-token-environment-variable/reference.md b/seed/ts-sdk/bearer-token-environment-variable/reference.md new file mode 100644 index 00000000000..92d3ed1d807 --- /dev/null +++ b/seed/ts-sdk/bearer-token-environment-variable/reference.md @@ -0,0 +1,58 @@ +# Reference + +## Service + +
client.service.getWithBearerToken() -> string +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET request with custom api key + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.getWithBearerToken(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/code-samples/reference.md b/seed/ts-sdk/code-samples/reference.md new file mode 100644 index 00000000000..ba59b95eb32 --- /dev/null +++ b/seed/ts-sdk/code-samples/reference.md @@ -0,0 +1,53 @@ +# Reference + +## Service + +
client.service.hello({ ...params }) -> SeedCodeSamples.MyResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.hello({ + numEvents: 5, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedCodeSamples.MyRequest` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/custom-auth/reference.md b/seed/ts-sdk/custom-auth/reference.md new file mode 100644 index 00000000000..5256ea2963d --- /dev/null +++ b/seed/ts-sdk/custom-auth/reference.md @@ -0,0 +1,123 @@ +# Reference + +## CustomAuth + +
client.customAuth.getWithCustomAuth() -> boolean +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET request with custom auth scheme + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.customAuth.getWithCustomAuth(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `CustomAuth.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.customAuth.postWithCustomAuth({ ...params }) -> boolean +
+
+ +#### 📝 Description + +
+
+ +
+
+ +POST request with custom auth scheme + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.customAuth.postWithCustomAuth({ + key: "value", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `unknown` + +
+
+ +
+
+ +**requestOptions:** `CustomAuth.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/enum/reference.md b/seed/ts-sdk/enum/reference.md new file mode 100644 index 00000000000..44ddcd2a5a5 --- /dev/null +++ b/seed/ts-sdk/enum/reference.md @@ -0,0 +1,239 @@ +# Reference + +## InlinedRequest + +
client.inlinedRequest.send({ ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.inlinedRequest.send({ + operand: SeedEnum.Operand.GreaterThan, + operandOrColor: SeedEnum.Color.Red, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedEnum.SendEnumInlinedRequest` + +
+
+ +
+
+ +**requestOptions:** `InlinedRequest.RequestOptions` + +
+
+
+
+ +
+
+
+ +## PathParam + +
client.pathParam.send(operand, maybeOperand, operandOrColor, maybeOperandOrColor) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.pathParam.send( + SeedEnum.Operand.GreaterThan, + SeedEnum.Operand.LessThan, + SeedEnum.Color.Red, + SeedEnum.Color.Red +); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**operand:** `SeedEnum.Operand` + +
+
+ +
+
+ +**maybeOperand:** `SeedEnum.Operand | undefined` + +
+
+ +
+
+ +**operandOrColor:** `SeedEnum.ColorOrOperand` + +
+
+ +
+
+ +**maybeOperandOrColor:** `SeedEnum.ColorOrOperand | undefined` + +
+
+ +
+
+ +**requestOptions:** `PathParam.RequestOptions` + +
+
+
+
+ +
+
+
+ +## QueryParam + +
client.queryParam.send({ ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.queryParam.send({ + operand: SeedEnum.Operand.GreaterThan, + operandOrColor: SeedEnum.Color.Red, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedEnum.SendEnumAsQueryParamRequest` + +
+
+ +
+
+ +**requestOptions:** `QueryParam.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.queryParam.sendList({ ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.queryParam.sendList({ + operand: SeedEnum.Operand.GreaterThan, + maybeOperand: SeedEnum.Operand.GreaterThan, + operandOrColor: SeedEnum.Color.Red, + maybeOperandOrColor: SeedEnum.Color.Red, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedEnum.SendEnumListAsQueryParamRequest` + +
+
+ +
+
+ +**requestOptions:** `QueryParam.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/error-property/union-utils/reference.md b/seed/ts-sdk/error-property/union-utils/reference.md new file mode 100644 index 00000000000..24aa7722ee5 --- /dev/null +++ b/seed/ts-sdk/error-property/union-utils/reference.md @@ -0,0 +1,58 @@ +# Reference + +## PropertyBasedError + +
client.propertyBasedError.throwError() -> string +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET request that always throws an error + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.propertyBasedError.throwError(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `PropertyBasedError.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/examples/examples-with-api-reference/reference.md b/seed/ts-sdk/examples/examples-with-api-reference/reference.md index 878d22c7d23..f567f64c747 100644 --- a/seed/ts-sdk/examples/examples-with-api-reference/reference.md +++ b/seed/ts-sdk/examples/examples-with-api-reference/reference.md @@ -1,553 +1,363 @@ -## Echo - -
client.echo({ ...params }) -> string +# Reference +
client.echo({ ...params }) -> string
-
#### 🔌 Usage
-
-
-```ts +```typescript await client.echo("Hello world!\\n\\nwith\\n\\tnewlines"); ```
-
-
-
#### ⚙️ Parameters
-
-
-**request: `string`** +**request:** `string`
-
-
-**requestOptions: `SeedExamplesClient.RequestOptions`** +**requestOptions:** `SeedExamplesClient.RequestOptions`
-
-
-
-
-## File Notification Service +## -
client.file.notification.service.getException(notificationId) -> SeedExamples.Exception +## File Notification Service +
client.file.notification.service.getException(notificationId) -> SeedExamples.Exception
-
#### 🔌 Usage
-
-
-```ts +```typescript await client.file.notification.service.getException("notification-hsy129x"); ```
-
-
-
#### ⚙️ Parameters
-
-
-**notificationId: `string`** +**notificationId:** `string`
-
-
-**requestOptions: `Service.RequestOptions`** +**requestOptions:** `Service.RequestOptions`
-
-
-
-
## File Service -
client.file.service.getFile(filename, { ...params }) -> SeedExamples.File_ - +
client.file.service.getFile(filename, { ...params }) -> SeedExamples.File_
-
#### 📝 Description
-
-
This endpoint returns a file by its name.
-
-
-
#### 🔌 Usage
-
-
-```ts +```typescript await client.file.service.getFile("file.txt", { xFileApiVersion: "0.0.2", }); ```
-
-
-
#### ⚙️ Parameters
-
-
-**filename: `string`** — This is a filename +**filename:** `string` — This is a filename
-
-
-**request: `SeedExamples.file.GetFileRequest`** +**request:** `SeedExamples.file.GetFileRequest`
-
-
-**requestOptions: `Service.RequestOptions`** +**requestOptions:** `Service.RequestOptions`
-
-
-
-
## Health Service -
client.health.service.check(id) -> void - +
client.health.service.check(id) -> void
-
#### 📝 Description
-
-
This endpoint checks the health of a resource.
-
-
-
#### 🔌 Usage
-
-
-```ts +```typescript await client.health.service.check("id-2sdx82h"); ```
-
-
-
#### ⚙️ Parameters
-
-
-**id: `string`** — The id to check +**id:** `string` — The id to check
-
-
-**requestOptions: `Service.RequestOptions`** +**requestOptions:** `Service.RequestOptions`
-
-
-
-
-
client.health.service.check(id) -> void - +
client.health.service.ping() -> boolean
-
#### 📝 Description
-
- -
- -This endpoint checks the health of a resource. - -
- -
- -
- -
- -#### 🔌 Usage - -
- -
- -
- -
- -```ts -await client.health.service.check("id-3tey93i"); -``` - -
- -
- -
- -
- -#### ⚙️ Parameters - -
- -
- -
- -
- -**id: `string`** — The id to check - -
- -
- -
- -
- -**requestOptions: `Service.RequestOptions`** - -
- -
- -
- -
- -
- -
-
- -
client.health.service.ping() -> boolean - -
- -
- -#### 📝 Description - -
- -
- -
-
This endpoint checks the health of the service.
-
-
-
#### 🔌 Usage
-
-
-```ts +```typescript await client.health.service.ping(); ```
-
-
-
#### ⚙️ Parameters
-
-
-**requestOptions: `Service.RequestOptions`** +**requestOptions:** `Service.RequestOptions`
-
-
-
-
## Service -
client.service.getMovie(movieId) -> SeedExamples.Movie - +
client.service.getMovie(movieId) -> SeedExamples.Movie
-
#### 🔌 Usage
-
-
-```ts +```typescript await client.service.getMovie("movie-c06a4ad7"); ```
-
-
-
#### ⚙️ Parameters
-
-
-**movieId: `SeedExamples.MovieId`** +**movieId:** `SeedExamples.MovieId`
-
-
-**requestOptions: `Service.RequestOptions`** +**requestOptions:** `Service.RequestOptions`
-
-
-
-
-
client.service.createMovie({ ...params }) -> SeedExamples.MovieId - +
client.service.createMovie({ ...params }) -> SeedExamples.MovieId
-
#### 🔌 Usage
-
-
-```ts +```typescript await client.service.createMovie({ id: "movie-c06a4ad7", prequel: "movie-cv9b914f", @@ -568,65 +378,50 @@ await client.service.createMovie({ ```
-
-
-
#### ⚙️ Parameters
-
-
-**request: `SeedExamples.Movie`** +**request:** `SeedExamples.Movie`
-
-
-**requestOptions: `Service.RequestOptions`** +**requestOptions:** `Service.RequestOptions`
-
-
-
-
-
client.service.getMetadata({ ...params }) -> SeedExamples.Metadata - +
client.service.getMetadata({ ...params }) -> SeedExamples.Metadata
-
#### 🔌 Usage
-
-
-```ts +```typescript await client.service.getMetadata({ xApiVersion: "0.0.1", shallow: false, @@ -635,97 +430,73 @@ await client.service.getMetadata({ ```
-
-
-
#### ⚙️ Parameters
-
-
-**request: `SeedExamples.GetMetadataRequest`** +**request:** `SeedExamples.GetMetadataRequest`
-
-
-**requestOptions: `Service.RequestOptions`** +**requestOptions:** `Service.RequestOptions`
-
-
-
-
-
client.service.getResponse() -> SeedExamples.Response - +
client.service.getResponse() -> SeedExamples.Response
-
#### 🔌 Usage
-
-
-```ts +```typescript await client.service.getResponse(); ```
-
-
-
#### ⚙️ Parameters
-
-
-**requestOptions: `Service.RequestOptions`** +**requestOptions:** `Service.RequestOptions`
-
-
-
-
diff --git a/seed/ts-sdk/examples/retain-original-casing/reference.md b/seed/ts-sdk/examples/retain-original-casing/reference.md new file mode 100644 index 00000000000..15de9f8c65f --- /dev/null +++ b/seed/ts-sdk/examples/retain-original-casing/reference.md @@ -0,0 +1,502 @@ +# Reference + +
client.echo({ ...params }) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.echo("Hello world!\\n\\nwith\\n\\tnewlines"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `SeedExamplesClient.RequestOptions` + +
+
+
+
+ +
+
+
+ +## + +## File Notification Service + +
client.file.notification.service.getException(notificationId) -> SeedExamples.Exception +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.file.notification.service.getException("notification-hsy129x"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**notificationId:** `string` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
+ +## File Service + +
client.file.service.getFile(filename, { ...params }) -> SeedExamples.File_ +
+
+ +#### 📝 Description + +
+
+ +
+
+ +This endpoint returns a file by its name. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.file.service.getFile("file.txt", { + "X-File-API-Version": "0.0.2", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**filename:** `string` — This is a filename + +
+
+ +
+
+ +**request:** `SeedExamples.file.GetFileRequest` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Health Service + +
client.health.service.check(id) -> void +
+
+ +#### 📝 Description + +
+
+ +
+
+ +This endpoint checks the health of a resource. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.health.service.check("id-2sdx82h"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` — The id to check + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.health.service.ping() -> boolean +
+
+ +#### 📝 Description + +
+
+ +
+
+ +This endpoint checks the health of the service. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.health.service.ping(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Service + +
client.service.getMovie(movieId) -> SeedExamples.Movie +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.getMovie("movie-c06a4ad7"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**movieId:** `SeedExamples.MovieId` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.service.createMovie({ ...params }) -> SeedExamples.MovieId +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.createMovie({ + id: "movie-c06a4ad7", + prequel: "movie-cv9b914f", + title: "The Boy and the Heron", + from: "Hayao Miyazaki", + rating: 8, + type: "movie", + tag: "tag-wf9as23d", + metadata: { + actors: ["Christian Bale", "Florence Pugh", "Willem Dafoe"], + releaseDate: "2023-12-08", + ratings: { + rottenTomatoes: 97, + imdb: 7.6, + }, + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExamples.Movie` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.service.getMetadata({ ...params }) -> SeedExamples.Metadata +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.getMetadata({ + "X-API-Version": "0.0.1", + shallow: false, + tag: "development", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExamples.GetMetadataRequest` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.service.getResponse() -> SeedExamples.Response +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.getResponse(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/exhaustive/allow-extra-fields/reference.md b/seed/ts-sdk/exhaustive/allow-extra-fields/reference.md new file mode 100644 index 00000000000..591fa376121 --- /dev/null +++ b/seed/ts-sdk/exhaustive/allow-extra-fields/reference.md @@ -0,0 +1,2183 @@ +# Reference + +## Endpoints Container + +
client.endpoints.container.getAndReturnListOfPrimitives({ ...params }) -> string[] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnListOfPrimitives(["string"]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string[]` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnListOfObjects({ ...params }) -> SeedExhaustive.ObjectWithRequiredField[] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnListOfObjects([ + { + string: "string", + }, +]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField[]` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnSetOfPrimitives({ ...params }) -> Set +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnSetOfPrimitives(new Set(["string"])); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Set` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnSetOfObjects({ ...params }) -> SeedExhaustive.ObjectWithRequiredField[] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnSetOfObjects( + new Set([ + { + string: "string", + }, + ]) +); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField[]` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnMapPrimToPrim({ ...params }) -> Record +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnMapPrimToPrim({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Record` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnMapOfPrimToObject({ ...params }) -> Record +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnMapOfPrimToObject({ + string: { + string: "string", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Record` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnOptional({ ...params }) -> SeedExhaustive.ObjectWithRequiredField | undefined +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnOptional({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Enum + +
client.endpoints.enum.getAndReturnEnum({ ...params }) -> SeedExhaustive.WeatherReport +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.enum.getAndReturnEnum(SeedExhaustive.WeatherReport.Sunny); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.WeatherReport` + +
+
+ +
+
+ +**requestOptions:** `Enum.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints HttpMethods + +
client.endpoints.httpMethods.testGet(id) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testGet("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testPost({ ...params }) -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testPost({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testPut(id, { ...params }) -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testPut("string", { + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testPatch(id, { ...params }) -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testPatch("string", { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithOptionalField` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testDelete(id) -> boolean +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testDelete("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Object + +
client.endpoints.object.getAndReturnWithOptionalField({ ...params }) -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnWithOptionalField({ + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithOptionalField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnWithRequiredField({ ...params }) -> SeedExhaustive.ObjectWithRequiredField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnWithRequiredField({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnWithMapOfMap({ ...params }) -> SeedExhaustive.ObjectWithMapOfMap +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnWithMapOfMap({ + map: { + string: { + string: "string", + }, + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithMapOfMap` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnNestedWithOptionalField({ ...params }) -> SeedExhaustive.NestedObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnNestedWithOptionalField({ + string: "string", + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.NestedObjectWithOptionalField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnNestedWithRequiredField(string, { ...params }) -> SeedExhaustive.NestedObjectWithRequiredField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnNestedWithRequiredField("string", { + string: "string", + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**string:** `string` + +
+
+ +
+
+ +**request:** `SeedExhaustive.NestedObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnNestedWithRequiredFieldAsList({ ...params }) -> SeedExhaustive.NestedObjectWithRequiredField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnNestedWithRequiredFieldAsList([ + { + string: "string", + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, + }, +]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.NestedObjectWithRequiredField[]` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Params + +
client.endpoints.params.getWithPath(param) -> string +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with path param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithPath("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `string` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.getWithQuery({ ...params }) -> void +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with query param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithQuery({ + query: "string", + number: 1, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.endpoints.GetWithQuery` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.getWithAllowMultipleQuery({ ...params }) -> void +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with multiple of same query param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithAllowMultipleQuery({ + query: "string", + numer: 1, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.endpoints.GetWithMultipleQuery` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.getWithPathAndQuery(param, { ...params }) -> void +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with path and query params + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithPathAndQuery("string", { + query: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `string` + +
+
+ +
+
+ +**request:** `SeedExhaustive.endpoints.GetWithPathAndQuery` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.modifyWithPath(param, { ...params }) -> string +
+
+ +#### 📝 Description + +
+
+ +
+
+ +PUT to update with path param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.modifyWithPath("string", "string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `string` + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Primitive + +
client.endpoints.primitive.getAndReturnString({ ...params }) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnString("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnInt({ ...params }) -> number +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnInt(1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `number` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnLong({ ...params }) -> number +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnLong(1000000); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `number` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnDouble({ ...params }) -> number +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnDouble(1.1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `number` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnBool({ ...params }) -> boolean +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnBool(true); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `boolean` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnDatetime({ ...params }) -> Date +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnDatetime(new Date("2024-01-15T09:30:00.000Z")); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Date` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnDate({ ...params }) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnDate("2023-01-15"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnUuid({ ...params }) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnBase64({ ...params }) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnBase64("SGVsbG8gd29ybGQh"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Union + +
client.endpoints.union.getAndReturnUnion({ ...params }) -> SeedExhaustive.Animal +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.union.getAndReturnUnion({ + animal: "dog", + name: "string", + likesToWoof: true, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.Animal` + +
+
+ +
+
+ +**requestOptions:** `Union.RequestOptions` + +
+
+
+
+ +
+
+
+ +## InlinedRequests + +
client.inlinedRequests.postWithObjectBodyandResponse({ ...params }) -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 📝 Description + +
+
+ +
+
+ +POST with custom object in request body, response is an object + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.inlinedRequests.postWithObjectBodyandResponse({ + string: "string", + integer: 1, + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.PostWithObjectBody` + +
+
+ +
+
+ +**requestOptions:** `InlinedRequests.RequestOptions` + +
+
+
+
+ +
+
+
+ +## NoAuth + +
client.noAuth.postWithNoAuth({ ...params }) -> boolean +
+
+ +#### 📝 Description + +
+
+ +
+
+ +POST request with no auth + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.noAuth.postWithNoAuth({ + key: "value", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `unknown` + +
+
+ +
+
+ +**requestOptions:** `NoAuth.RequestOptions` + +
+
+
+
+ +
+
+
+ +## NoReqBody + +
client.noReqBody.getWithNoRequestBody() -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.noReqBody.getWithNoRequestBody(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `NoReqBody.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.noReqBody.postWithNoRequestBody() -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.noReqBody.postWithNoRequestBody(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `NoReqBody.RequestOptions` + +
+
+
+
+ +
+
+
+ +## ReqWithHeaders + +
client.reqWithHeaders.getWithCustomHeader({ ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.reqWithHeaders.getWithCustomHeader({ + xTestServiceHeader: "string", + xTestEndpointHeader: "string", + body: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ReqWithHeaders` + +
+
+ +
+
+ +**requestOptions:** `ReqWithHeaders.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/exhaustive/bundle/reference.md b/seed/ts-sdk/exhaustive/bundle/reference.md new file mode 100644 index 00000000000..905f3bb3c98 --- /dev/null +++ b/seed/ts-sdk/exhaustive/bundle/reference.md @@ -0,0 +1,2184 @@ +# Reference + +## Endpoints Container + +
client.endpoints.container.getAndReturnListOfPrimitives({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnListOfPrimitives(["string"]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string[]` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnListOfObjects({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnListOfObjects([ + { + string: "string", + }, +]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithRequiredField[]` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnSetOfPrimitives({ ...params }) -> core.APIResponse, Fiddle.endpoints.container.getAndReturnSetOfPrimitives.Error> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnSetOfPrimitives(new Set(["string"])); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Set` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnSetOfObjects({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnSetOfObjects( + new Set([ + { + string: "string", + }, + ]) +); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithRequiredField[]` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnMapPrimToPrim({ ...params }) -> core.APIResponse, Fiddle.endpoints.container.getAndReturnMapPrimToPrim.Error> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnMapPrimToPrim({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Record` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnMapOfPrimToObject({ ...params }) -> core.APIResponse, Fiddle.endpoints.container.getAndReturnMapOfPrimToObject.Error> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnMapOfPrimToObject({ + string: { + string: "string", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Record` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnOptional({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnOptional({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Enum + +
client.endpoints.enum.getAndReturnEnum({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.enum.getAndReturnEnum(Fiddle.WeatherReport.Sunny); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.WeatherReport` + +
+
+ +
+
+ +**requestOptions:** `Enum.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints HttpMethods + +
client.endpoints.httpMethods.testGet(id) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testGet("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testPost({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testPost({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testPut(id, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testPut("string", { + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testPatch(id, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testPatch("string", { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithOptionalField` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testDelete(id) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testDelete("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Object + +
client.endpoints.object.getAndReturnWithOptionalField({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnWithOptionalField({ + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithOptionalField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnWithRequiredField({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnWithRequiredField({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnWithMapOfMap({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnWithMapOfMap({ + map: { + string: { + string: "string", + }, + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithMapOfMap` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnNestedWithOptionalField({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnNestedWithOptionalField({ + string: "string", + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.NestedObjectWithOptionalField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnNestedWithRequiredField(string, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnNestedWithRequiredField("string", { + string: "string", + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**string:** `string` + +
+
+ +
+
+ +**request:** `Fiddle.NestedObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnNestedWithRequiredFieldAsList({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnNestedWithRequiredFieldAsList([ + { + string: "string", + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, + }, +]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.NestedObjectWithRequiredField[]` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Params + +
client.endpoints.params.getWithPath(param) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with path param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithPath("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `string` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.getWithQuery({ ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with query param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithQuery({ + query: "string", + number: 1, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.endpoints.GetWithQuery` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.getWithAllowMultipleQuery({ ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with multiple of same query param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithAllowMultipleQuery({ + query: "string", + numer: 1, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.endpoints.GetWithMultipleQuery` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.getWithPathAndQuery(param, { ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with path and query params + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithPathAndQuery("string", { + query: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `string` + +
+
+ +
+
+ +**request:** `Fiddle.endpoints.GetWithPathAndQuery` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.modifyWithPath(param, { ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +PUT to update with path param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.modifyWithPath("string", "string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `string` + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Primitive + +
client.endpoints.primitive.getAndReturnString({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnString("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnInt({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnInt(1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `number` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnLong({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnLong(1000000); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `number` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnDouble({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnDouble(1.1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `number` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnBool({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnBool(true); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `boolean` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnDatetime({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnDatetime(new Date("2024-01-15T09:30:00.000Z")); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Date` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnDate({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnDate("2023-01-15"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnUuid({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnBase64({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnBase64("SGVsbG8gd29ybGQh"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Union + +
client.endpoints.union.getAndReturnUnion({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.union.getAndReturnUnion( + Fiddle.Animal.dog({ + name: "string", + likesToWoof: true, + }) +); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.Animal` + +
+
+ +
+
+ +**requestOptions:** `Union.RequestOptions` + +
+
+
+
+ +
+
+
+ +## InlinedRequests + +
client.inlinedRequests.postWithObjectBodyandResponse({ ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +POST with custom object in request body, response is an object + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.inlinedRequests.postWithObjectBodyandResponse({ + string: "string", + integer: 1, + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.PostWithObjectBody` + +
+
+ +
+
+ +**requestOptions:** `InlinedRequests.RequestOptions` + +
+
+
+
+ +
+
+
+ +## NoAuth + +
client.noAuth.postWithNoAuth({ ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +POST request with no auth + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.noAuth.postWithNoAuth({ + key: "value", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `unknown` + +
+
+ +
+
+ +**requestOptions:** `NoAuth.RequestOptions` + +
+
+
+
+ +
+
+
+ +## NoReqBody + +
client.noReqBody.getWithNoRequestBody() -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.noReqBody.getWithNoRequestBody(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `NoReqBody.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.noReqBody.postWithNoRequestBody() -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.noReqBody.postWithNoRequestBody(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `NoReqBody.RequestOptions` + +
+
+
+
+ +
+
+
+ +## ReqWithHeaders + +
client.reqWithHeaders.getWithCustomHeader({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.reqWithHeaders.getWithCustomHeader({ + xTestServiceHeader: "string", + xTestEndpointHeader: "string", + body: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ReqWithHeaders` + +
+
+ +
+
+ +**requestOptions:** `ReqWithHeaders.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/exhaustive/custom-package-json/reference.md b/seed/ts-sdk/exhaustive/custom-package-json/reference.md new file mode 100644 index 00000000000..905f3bb3c98 --- /dev/null +++ b/seed/ts-sdk/exhaustive/custom-package-json/reference.md @@ -0,0 +1,2184 @@ +# Reference + +## Endpoints Container + +
client.endpoints.container.getAndReturnListOfPrimitives({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnListOfPrimitives(["string"]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string[]` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnListOfObjects({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnListOfObjects([ + { + string: "string", + }, +]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithRequiredField[]` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnSetOfPrimitives({ ...params }) -> core.APIResponse, Fiddle.endpoints.container.getAndReturnSetOfPrimitives.Error> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnSetOfPrimitives(new Set(["string"])); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Set` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnSetOfObjects({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnSetOfObjects( + new Set([ + { + string: "string", + }, + ]) +); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithRequiredField[]` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnMapPrimToPrim({ ...params }) -> core.APIResponse, Fiddle.endpoints.container.getAndReturnMapPrimToPrim.Error> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnMapPrimToPrim({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Record` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnMapOfPrimToObject({ ...params }) -> core.APIResponse, Fiddle.endpoints.container.getAndReturnMapOfPrimToObject.Error> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnMapOfPrimToObject({ + string: { + string: "string", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Record` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnOptional({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnOptional({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Enum + +
client.endpoints.enum.getAndReturnEnum({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.enum.getAndReturnEnum(Fiddle.WeatherReport.Sunny); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.WeatherReport` + +
+
+ +
+
+ +**requestOptions:** `Enum.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints HttpMethods + +
client.endpoints.httpMethods.testGet(id) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testGet("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testPost({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testPost({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testPut(id, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testPut("string", { + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testPatch(id, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testPatch("string", { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithOptionalField` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testDelete(id) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testDelete("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Object + +
client.endpoints.object.getAndReturnWithOptionalField({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnWithOptionalField({ + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithOptionalField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnWithRequiredField({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnWithRequiredField({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnWithMapOfMap({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnWithMapOfMap({ + map: { + string: { + string: "string", + }, + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithMapOfMap` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnNestedWithOptionalField({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnNestedWithOptionalField({ + string: "string", + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.NestedObjectWithOptionalField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnNestedWithRequiredField(string, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnNestedWithRequiredField("string", { + string: "string", + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**string:** `string` + +
+
+ +
+
+ +**request:** `Fiddle.NestedObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnNestedWithRequiredFieldAsList({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnNestedWithRequiredFieldAsList([ + { + string: "string", + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, + }, +]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.NestedObjectWithRequiredField[]` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Params + +
client.endpoints.params.getWithPath(param) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with path param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithPath("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `string` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.getWithQuery({ ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with query param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithQuery({ + query: "string", + number: 1, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.endpoints.GetWithQuery` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.getWithAllowMultipleQuery({ ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with multiple of same query param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithAllowMultipleQuery({ + query: "string", + numer: 1, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.endpoints.GetWithMultipleQuery` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.getWithPathAndQuery(param, { ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with path and query params + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithPathAndQuery("string", { + query: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `string` + +
+
+ +
+
+ +**request:** `Fiddle.endpoints.GetWithPathAndQuery` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.modifyWithPath(param, { ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +PUT to update with path param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.modifyWithPath("string", "string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `string` + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Primitive + +
client.endpoints.primitive.getAndReturnString({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnString("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnInt({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnInt(1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `number` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnLong({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnLong(1000000); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `number` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnDouble({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnDouble(1.1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `number` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnBool({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnBool(true); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `boolean` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnDatetime({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnDatetime(new Date("2024-01-15T09:30:00.000Z")); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Date` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnDate({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnDate("2023-01-15"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnUuid({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnBase64({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnBase64("SGVsbG8gd29ybGQh"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Union + +
client.endpoints.union.getAndReturnUnion({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.union.getAndReturnUnion( + Fiddle.Animal.dog({ + name: "string", + likesToWoof: true, + }) +); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.Animal` + +
+
+ +
+
+ +**requestOptions:** `Union.RequestOptions` + +
+
+
+
+ +
+
+
+ +## InlinedRequests + +
client.inlinedRequests.postWithObjectBodyandResponse({ ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +POST with custom object in request body, response is an object + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.inlinedRequests.postWithObjectBodyandResponse({ + string: "string", + integer: 1, + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.PostWithObjectBody` + +
+
+ +
+
+ +**requestOptions:** `InlinedRequests.RequestOptions` + +
+
+
+
+ +
+
+
+ +## NoAuth + +
client.noAuth.postWithNoAuth({ ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +POST request with no auth + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.noAuth.postWithNoAuth({ + key: "value", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `unknown` + +
+
+ +
+
+ +**requestOptions:** `NoAuth.RequestOptions` + +
+
+
+
+ +
+
+
+ +## NoReqBody + +
client.noReqBody.getWithNoRequestBody() -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.noReqBody.getWithNoRequestBody(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `NoReqBody.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.noReqBody.postWithNoRequestBody() -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.noReqBody.postWithNoRequestBody(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `NoReqBody.RequestOptions` + +
+
+
+
+ +
+
+
+ +## ReqWithHeaders + +
client.reqWithHeaders.getWithCustomHeader({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.reqWithHeaders.getWithCustomHeader({ + xTestServiceHeader: "string", + xTestEndpointHeader: "string", + body: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ReqWithHeaders` + +
+
+ +
+
+ +**requestOptions:** `ReqWithHeaders.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/exhaustive/dev-dependencies/reference.md b/seed/ts-sdk/exhaustive/dev-dependencies/reference.md new file mode 100644 index 00000000000..905f3bb3c98 --- /dev/null +++ b/seed/ts-sdk/exhaustive/dev-dependencies/reference.md @@ -0,0 +1,2184 @@ +# Reference + +## Endpoints Container + +
client.endpoints.container.getAndReturnListOfPrimitives({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnListOfPrimitives(["string"]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string[]` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnListOfObjects({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnListOfObjects([ + { + string: "string", + }, +]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithRequiredField[]` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnSetOfPrimitives({ ...params }) -> core.APIResponse, Fiddle.endpoints.container.getAndReturnSetOfPrimitives.Error> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnSetOfPrimitives(new Set(["string"])); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Set` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnSetOfObjects({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnSetOfObjects( + new Set([ + { + string: "string", + }, + ]) +); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithRequiredField[]` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnMapPrimToPrim({ ...params }) -> core.APIResponse, Fiddle.endpoints.container.getAndReturnMapPrimToPrim.Error> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnMapPrimToPrim({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Record` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnMapOfPrimToObject({ ...params }) -> core.APIResponse, Fiddle.endpoints.container.getAndReturnMapOfPrimToObject.Error> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnMapOfPrimToObject({ + string: { + string: "string", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Record` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnOptional({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnOptional({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Enum + +
client.endpoints.enum.getAndReturnEnum({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.enum.getAndReturnEnum(Fiddle.WeatherReport.Sunny); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.WeatherReport` + +
+
+ +
+
+ +**requestOptions:** `Enum.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints HttpMethods + +
client.endpoints.httpMethods.testGet(id) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testGet("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testPost({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testPost({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testPut(id, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testPut("string", { + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testPatch(id, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testPatch("string", { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithOptionalField` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testDelete(id) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testDelete("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Object + +
client.endpoints.object.getAndReturnWithOptionalField({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnWithOptionalField({ + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithOptionalField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnWithRequiredField({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnWithRequiredField({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnWithMapOfMap({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnWithMapOfMap({ + map: { + string: { + string: "string", + }, + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ObjectWithMapOfMap` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnNestedWithOptionalField({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnNestedWithOptionalField({ + string: "string", + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.NestedObjectWithOptionalField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnNestedWithRequiredField(string, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnNestedWithRequiredField("string", { + string: "string", + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**string:** `string` + +
+
+ +
+
+ +**request:** `Fiddle.NestedObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnNestedWithRequiredFieldAsList({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnNestedWithRequiredFieldAsList([ + { + string: "string", + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, + }, +]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.NestedObjectWithRequiredField[]` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Params + +
client.endpoints.params.getWithPath(param) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with path param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithPath("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `string` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.getWithQuery({ ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with query param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithQuery({ + query: "string", + number: 1, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.endpoints.GetWithQuery` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.getWithAllowMultipleQuery({ ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with multiple of same query param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithAllowMultipleQuery({ + query: "string", + numer: 1, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.endpoints.GetWithMultipleQuery` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.getWithPathAndQuery(param, { ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with path and query params + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithPathAndQuery("string", { + query: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `string` + +
+
+ +
+
+ +**request:** `Fiddle.endpoints.GetWithPathAndQuery` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.modifyWithPath(param, { ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +PUT to update with path param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.modifyWithPath("string", "string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `string` + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Primitive + +
client.endpoints.primitive.getAndReturnString({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnString("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnInt({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnInt(1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `number` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnLong({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnLong(1000000); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `number` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnDouble({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnDouble(1.1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `number` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnBool({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnBool(true); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `boolean` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnDatetime({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnDatetime(new Date("2024-01-15T09:30:00.000Z")); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Date` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnDate({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnDate("2023-01-15"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnUuid({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnBase64({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnBase64("SGVsbG8gd29ybGQh"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Union + +
client.endpoints.union.getAndReturnUnion({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.union.getAndReturnUnion( + Fiddle.Animal.dog({ + name: "string", + likesToWoof: true, + }) +); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.Animal` + +
+
+ +
+
+ +**requestOptions:** `Union.RequestOptions` + +
+
+
+
+ +
+
+
+ +## InlinedRequests + +
client.inlinedRequests.postWithObjectBodyandResponse({ ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +POST with custom object in request body, response is an object + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.inlinedRequests.postWithObjectBodyandResponse({ + string: "string", + integer: 1, + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.PostWithObjectBody` + +
+
+ +
+
+ +**requestOptions:** `InlinedRequests.RequestOptions` + +
+
+
+
+ +
+
+
+ +## NoAuth + +
client.noAuth.postWithNoAuth({ ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +POST request with no auth + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.noAuth.postWithNoAuth({ + key: "value", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `unknown` + +
+
+ +
+
+ +**requestOptions:** `NoAuth.RequestOptions` + +
+
+
+
+ +
+
+
+ +## NoReqBody + +
client.noReqBody.getWithNoRequestBody() -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.noReqBody.getWithNoRequestBody(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `NoReqBody.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.noReqBody.postWithNoRequestBody() -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.noReqBody.postWithNoRequestBody(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `NoReqBody.RequestOptions` + +
+
+
+
+ +
+
+
+ +## ReqWithHeaders + +
client.reqWithHeaders.getWithCustomHeader({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.reqWithHeaders.getWithCustomHeader({ + xTestServiceHeader: "string", + xTestEndpointHeader: "string", + body: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Fiddle.ReqWithHeaders` + +
+
+ +
+
+ +**requestOptions:** `ReqWithHeaders.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/exhaustive/jsr/reference.md b/seed/ts-sdk/exhaustive/jsr/reference.md new file mode 100644 index 00000000000..591fa376121 --- /dev/null +++ b/seed/ts-sdk/exhaustive/jsr/reference.md @@ -0,0 +1,2183 @@ +# Reference + +## Endpoints Container + +
client.endpoints.container.getAndReturnListOfPrimitives({ ...params }) -> string[] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnListOfPrimitives(["string"]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string[]` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnListOfObjects({ ...params }) -> SeedExhaustive.ObjectWithRequiredField[] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnListOfObjects([ + { + string: "string", + }, +]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField[]` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnSetOfPrimitives({ ...params }) -> Set +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnSetOfPrimitives(new Set(["string"])); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Set` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnSetOfObjects({ ...params }) -> SeedExhaustive.ObjectWithRequiredField[] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnSetOfObjects( + new Set([ + { + string: "string", + }, + ]) +); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField[]` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnMapPrimToPrim({ ...params }) -> Record +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnMapPrimToPrim({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Record` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnMapOfPrimToObject({ ...params }) -> Record +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnMapOfPrimToObject({ + string: { + string: "string", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Record` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnOptional({ ...params }) -> SeedExhaustive.ObjectWithRequiredField | undefined +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnOptional({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Enum + +
client.endpoints.enum.getAndReturnEnum({ ...params }) -> SeedExhaustive.WeatherReport +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.enum.getAndReturnEnum(SeedExhaustive.WeatherReport.Sunny); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.WeatherReport` + +
+
+ +
+
+ +**requestOptions:** `Enum.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints HttpMethods + +
client.endpoints.httpMethods.testGet(id) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testGet("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testPost({ ...params }) -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testPost({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testPut(id, { ...params }) -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testPut("string", { + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testPatch(id, { ...params }) -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testPatch("string", { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithOptionalField` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testDelete(id) -> boolean +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testDelete("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Object + +
client.endpoints.object.getAndReturnWithOptionalField({ ...params }) -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnWithOptionalField({ + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithOptionalField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnWithRequiredField({ ...params }) -> SeedExhaustive.ObjectWithRequiredField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnWithRequiredField({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnWithMapOfMap({ ...params }) -> SeedExhaustive.ObjectWithMapOfMap +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnWithMapOfMap({ + map: { + string: { + string: "string", + }, + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithMapOfMap` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnNestedWithOptionalField({ ...params }) -> SeedExhaustive.NestedObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnNestedWithOptionalField({ + string: "string", + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.NestedObjectWithOptionalField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnNestedWithRequiredField(string, { ...params }) -> SeedExhaustive.NestedObjectWithRequiredField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnNestedWithRequiredField("string", { + string: "string", + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**string:** `string` + +
+
+ +
+
+ +**request:** `SeedExhaustive.NestedObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnNestedWithRequiredFieldAsList({ ...params }) -> SeedExhaustive.NestedObjectWithRequiredField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnNestedWithRequiredFieldAsList([ + { + string: "string", + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, + }, +]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.NestedObjectWithRequiredField[]` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Params + +
client.endpoints.params.getWithPath(param) -> string +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with path param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithPath("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `string` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.getWithQuery({ ...params }) -> void +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with query param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithQuery({ + query: "string", + number: 1, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.endpoints.GetWithQuery` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.getWithAllowMultipleQuery({ ...params }) -> void +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with multiple of same query param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithAllowMultipleQuery({ + query: "string", + numer: 1, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.endpoints.GetWithMultipleQuery` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.getWithPathAndQuery(param, { ...params }) -> void +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with path and query params + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithPathAndQuery("string", { + query: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `string` + +
+
+ +
+
+ +**request:** `SeedExhaustive.endpoints.GetWithPathAndQuery` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.modifyWithPath(param, { ...params }) -> string +
+
+ +#### 📝 Description + +
+
+ +
+
+ +PUT to update with path param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.modifyWithPath("string", "string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `string` + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Primitive + +
client.endpoints.primitive.getAndReturnString({ ...params }) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnString("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnInt({ ...params }) -> number +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnInt(1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `number` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnLong({ ...params }) -> number +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnLong(1000000); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `number` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnDouble({ ...params }) -> number +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnDouble(1.1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `number` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnBool({ ...params }) -> boolean +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnBool(true); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `boolean` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnDatetime({ ...params }) -> Date +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnDatetime(new Date("2024-01-15T09:30:00.000Z")); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Date` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnDate({ ...params }) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnDate("2023-01-15"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnUuid({ ...params }) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnBase64({ ...params }) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnBase64("SGVsbG8gd29ybGQh"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Union + +
client.endpoints.union.getAndReturnUnion({ ...params }) -> SeedExhaustive.Animal +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.union.getAndReturnUnion({ + animal: "dog", + name: "string", + likesToWoof: true, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.Animal` + +
+
+ +
+
+ +**requestOptions:** `Union.RequestOptions` + +
+
+
+
+ +
+
+
+ +## InlinedRequests + +
client.inlinedRequests.postWithObjectBodyandResponse({ ...params }) -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 📝 Description + +
+
+ +
+
+ +POST with custom object in request body, response is an object + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.inlinedRequests.postWithObjectBodyandResponse({ + string: "string", + integer: 1, + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.PostWithObjectBody` + +
+
+ +
+
+ +**requestOptions:** `InlinedRequests.RequestOptions` + +
+
+
+
+ +
+
+
+ +## NoAuth + +
client.noAuth.postWithNoAuth({ ...params }) -> boolean +
+
+ +#### 📝 Description + +
+
+ +
+
+ +POST request with no auth + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.noAuth.postWithNoAuth({ + key: "value", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `unknown` + +
+
+ +
+
+ +**requestOptions:** `NoAuth.RequestOptions` + +
+
+
+
+ +
+
+
+ +## NoReqBody + +
client.noReqBody.getWithNoRequestBody() -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.noReqBody.getWithNoRequestBody(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `NoReqBody.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.noReqBody.postWithNoRequestBody() -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.noReqBody.postWithNoRequestBody(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `NoReqBody.RequestOptions` + +
+
+
+
+ +
+
+
+ +## ReqWithHeaders + +
client.reqWithHeaders.getWithCustomHeader({ ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.reqWithHeaders.getWithCustomHeader({ + xTestServiceHeader: "string", + xTestEndpointHeader: "string", + body: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ReqWithHeaders` + +
+
+ +
+
+ +**requestOptions:** `ReqWithHeaders.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/exhaustive/no-custom-config/reference.md b/seed/ts-sdk/exhaustive/no-custom-config/reference.md new file mode 100644 index 00000000000..591fa376121 --- /dev/null +++ b/seed/ts-sdk/exhaustive/no-custom-config/reference.md @@ -0,0 +1,2183 @@ +# Reference + +## Endpoints Container + +
client.endpoints.container.getAndReturnListOfPrimitives({ ...params }) -> string[] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnListOfPrimitives(["string"]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string[]` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnListOfObjects({ ...params }) -> SeedExhaustive.ObjectWithRequiredField[] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnListOfObjects([ + { + string: "string", + }, +]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField[]` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnSetOfPrimitives({ ...params }) -> Set +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnSetOfPrimitives(new Set(["string"])); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Set` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnSetOfObjects({ ...params }) -> SeedExhaustive.ObjectWithRequiredField[] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnSetOfObjects( + new Set([ + { + string: "string", + }, + ]) +); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField[]` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnMapPrimToPrim({ ...params }) -> Record +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnMapPrimToPrim({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Record` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnMapOfPrimToObject({ ...params }) -> Record +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnMapOfPrimToObject({ + string: { + string: "string", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Record` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnOptional({ ...params }) -> SeedExhaustive.ObjectWithRequiredField | undefined +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnOptional({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Enum + +
client.endpoints.enum.getAndReturnEnum({ ...params }) -> SeedExhaustive.WeatherReport +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.enum.getAndReturnEnum(SeedExhaustive.WeatherReport.Sunny); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.WeatherReport` + +
+
+ +
+
+ +**requestOptions:** `Enum.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints HttpMethods + +
client.endpoints.httpMethods.testGet(id) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testGet("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testPost({ ...params }) -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testPost({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testPut(id, { ...params }) -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testPut("string", { + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testPatch(id, { ...params }) -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testPatch("string", { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithOptionalField` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testDelete(id) -> boolean +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testDelete("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Object + +
client.endpoints.object.getAndReturnWithOptionalField({ ...params }) -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnWithOptionalField({ + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithOptionalField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnWithRequiredField({ ...params }) -> SeedExhaustive.ObjectWithRequiredField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnWithRequiredField({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnWithMapOfMap({ ...params }) -> SeedExhaustive.ObjectWithMapOfMap +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnWithMapOfMap({ + map: { + string: { + string: "string", + }, + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithMapOfMap` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnNestedWithOptionalField({ ...params }) -> SeedExhaustive.NestedObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnNestedWithOptionalField({ + string: "string", + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.NestedObjectWithOptionalField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnNestedWithRequiredField(string, { ...params }) -> SeedExhaustive.NestedObjectWithRequiredField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnNestedWithRequiredField("string", { + string: "string", + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**string:** `string` + +
+
+ +
+
+ +**request:** `SeedExhaustive.NestedObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnNestedWithRequiredFieldAsList({ ...params }) -> SeedExhaustive.NestedObjectWithRequiredField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnNestedWithRequiredFieldAsList([ + { + string: "string", + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, + }, +]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.NestedObjectWithRequiredField[]` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Params + +
client.endpoints.params.getWithPath(param) -> string +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with path param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithPath("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `string` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.getWithQuery({ ...params }) -> void +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with query param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithQuery({ + query: "string", + number: 1, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.endpoints.GetWithQuery` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.getWithAllowMultipleQuery({ ...params }) -> void +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with multiple of same query param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithAllowMultipleQuery({ + query: "string", + numer: 1, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.endpoints.GetWithMultipleQuery` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.getWithPathAndQuery(param, { ...params }) -> void +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with path and query params + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithPathAndQuery("string", { + query: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `string` + +
+
+ +
+
+ +**request:** `SeedExhaustive.endpoints.GetWithPathAndQuery` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.modifyWithPath(param, { ...params }) -> string +
+
+ +#### 📝 Description + +
+
+ +
+
+ +PUT to update with path param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.modifyWithPath("string", "string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `string` + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Primitive + +
client.endpoints.primitive.getAndReturnString({ ...params }) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnString("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnInt({ ...params }) -> number +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnInt(1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `number` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnLong({ ...params }) -> number +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnLong(1000000); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `number` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnDouble({ ...params }) -> number +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnDouble(1.1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `number` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnBool({ ...params }) -> boolean +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnBool(true); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `boolean` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnDatetime({ ...params }) -> Date +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnDatetime(new Date("2024-01-15T09:30:00.000Z")); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Date` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnDate({ ...params }) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnDate("2023-01-15"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnUuid({ ...params }) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnBase64({ ...params }) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnBase64("SGVsbG8gd29ybGQh"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Union + +
client.endpoints.union.getAndReturnUnion({ ...params }) -> SeedExhaustive.Animal +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.union.getAndReturnUnion({ + animal: "dog", + name: "string", + likesToWoof: true, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.Animal` + +
+
+ +
+
+ +**requestOptions:** `Union.RequestOptions` + +
+
+
+
+ +
+
+
+ +## InlinedRequests + +
client.inlinedRequests.postWithObjectBodyandResponse({ ...params }) -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 📝 Description + +
+
+ +
+
+ +POST with custom object in request body, response is an object + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.inlinedRequests.postWithObjectBodyandResponse({ + string: "string", + integer: 1, + nestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.PostWithObjectBody` + +
+
+ +
+
+ +**requestOptions:** `InlinedRequests.RequestOptions` + +
+
+
+
+ +
+
+
+ +## NoAuth + +
client.noAuth.postWithNoAuth({ ...params }) -> boolean +
+
+ +#### 📝 Description + +
+
+ +
+
+ +POST request with no auth + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.noAuth.postWithNoAuth({ + key: "value", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `unknown` + +
+
+ +
+
+ +**requestOptions:** `NoAuth.RequestOptions` + +
+
+
+
+ +
+
+
+ +## NoReqBody + +
client.noReqBody.getWithNoRequestBody() -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.noReqBody.getWithNoRequestBody(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `NoReqBody.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.noReqBody.postWithNoRequestBody() -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.noReqBody.postWithNoRequestBody(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `NoReqBody.RequestOptions` + +
+
+
+
+ +
+
+
+ +## ReqWithHeaders + +
client.reqWithHeaders.getWithCustomHeader({ ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.reqWithHeaders.getWithCustomHeader({ + xTestServiceHeader: "string", + xTestEndpointHeader: "string", + body: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ReqWithHeaders` + +
+
+ +
+
+ +**requestOptions:** `ReqWithHeaders.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/exhaustive/retain-original-casing/reference.md b/seed/ts-sdk/exhaustive/retain-original-casing/reference.md new file mode 100644 index 00000000000..e78c2c9d503 --- /dev/null +++ b/seed/ts-sdk/exhaustive/retain-original-casing/reference.md @@ -0,0 +1,2183 @@ +# Reference + +## Endpoints Container + +
client.endpoints.container.getAndReturnListOfPrimitives({ ...params }) -> string[] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnListOfPrimitives(["string"]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string[]` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnListOfObjects({ ...params }) -> SeedExhaustive.ObjectWithRequiredField[] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnListOfObjects([ + { + string: "string", + }, +]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField[]` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnSetOfPrimitives({ ...params }) -> Set +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnSetOfPrimitives(new Set(["string"])); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Set` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnSetOfObjects({ ...params }) -> SeedExhaustive.ObjectWithRequiredField[] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnSetOfObjects( + new Set([ + { + string: "string", + }, + ]) +); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField[]` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnMapPrimToPrim({ ...params }) -> Record +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnMapPrimToPrim({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Record` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnMapOfPrimToObject({ ...params }) -> Record +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnMapOfPrimToObject({ + string: { + string: "string", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Record` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.container.getAndReturnOptional({ ...params }) -> SeedExhaustive.ObjectWithRequiredField | undefined +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.container.getAndReturnOptional({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `Container.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Enum + +
client.endpoints.enum.getAndReturnEnum({ ...params }) -> SeedExhaustive.WeatherReport +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.enum.getAndReturnEnum(SeedExhaustive.WeatherReport.Sunny); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.WeatherReport` + +
+
+ +
+
+ +**requestOptions:** `Enum.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints HttpMethods + +
client.endpoints.httpMethods.testGet(id) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testGet("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testPost({ ...params }) -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testPost({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testPut(id, { ...params }) -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testPut("string", { + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testPatch(id, { ...params }) -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testPatch("string", { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithOptionalField` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.httpMethods.testDelete(id) -> boolean +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.httpMethods.testDelete("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**requestOptions:** `HttpMethods.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Object + +
client.endpoints.object.getAndReturnWithOptionalField({ ...params }) -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnWithOptionalField({ + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithOptionalField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnWithRequiredField({ ...params }) -> SeedExhaustive.ObjectWithRequiredField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnWithRequiredField({ + string: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnWithMapOfMap({ ...params }) -> SeedExhaustive.ObjectWithMapOfMap +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnWithMapOfMap({ + map: { + string: { + string: "string", + }, + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ObjectWithMapOfMap` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnNestedWithOptionalField({ ...params }) -> SeedExhaustive.NestedObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnNestedWithOptionalField({ + string: "string", + NestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.NestedObjectWithOptionalField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnNestedWithRequiredField(string, { ...params }) -> SeedExhaustive.NestedObjectWithRequiredField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnNestedWithRequiredField("string", { + string: "string", + NestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**string:** `string` + +
+
+ +
+
+ +**request:** `SeedExhaustive.NestedObjectWithRequiredField` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.object.getAndReturnNestedWithRequiredFieldAsList({ ...params }) -> SeedExhaustive.NestedObjectWithRequiredField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.object.getAndReturnNestedWithRequiredFieldAsList([ + { + string: "string", + NestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, + }, +]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.NestedObjectWithRequiredField[]` + +
+
+ +
+
+ +**requestOptions:** `Object_.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Params + +
client.endpoints.params.getWithPath(param) -> string +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with path param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithPath("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `string` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.getWithQuery({ ...params }) -> void +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with query param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithQuery({ + query: "string", + number: 1, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.endpoints.GetWithQuery` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.getWithAllowMultipleQuery({ ...params }) -> void +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with multiple of same query param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithAllowMultipleQuery({ + query: "string", + numer: 1, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.endpoints.GetWithMultipleQuery` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.getWithPathAndQuery(param, { ...params }) -> void +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with path and query params + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.getWithPathAndQuery("string", { + query: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `string` + +
+
+ +
+
+ +**request:** `SeedExhaustive.endpoints.GetWithPathAndQuery` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.params.modifyWithPath(param, { ...params }) -> string +
+
+ +#### 📝 Description + +
+
+ +
+
+ +PUT to update with path param + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.params.modifyWithPath("string", "string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `string` + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Params.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Primitive + +
client.endpoints.primitive.getAndReturnString({ ...params }) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnString("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnInt({ ...params }) -> number +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnInt(1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `number` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnLong({ ...params }) -> number +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnLong(1000000); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `number` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnDouble({ ...params }) -> number +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnDouble(1.1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `number` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnBool({ ...params }) -> boolean +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnBool(true); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `boolean` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnDatetime({ ...params }) -> Date +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnDatetime(new Date("2024-01-15T09:30:00.000Z")); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Date` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnDate({ ...params }) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnDate("2023-01-15"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnUuid({ ...params }) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.endpoints.primitive.getAndReturnBase64({ ...params }) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.primitive.getAndReturnBase64("SGVsbG8gd29ybGQh"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Primitive.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Endpoints Union + +
client.endpoints.union.getAndReturnUnion({ ...params }) -> SeedExhaustive.Animal +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.endpoints.union.getAndReturnUnion({ + animal: "dog", + name: "string", + likesToWoof: true, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.Animal` + +
+
+ +
+
+ +**requestOptions:** `Union.RequestOptions` + +
+
+
+
+ +
+
+
+ +## InlinedRequests + +
client.inlinedRequests.postWithObjectBodyandResponse({ ...params }) -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 📝 Description + +
+
+ +
+
+ +POST with custom object in request body, response is an object + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.inlinedRequests.postWithObjectBodyandResponse({ + string: "string", + integer: 1, + NestedObject: { + string: "string", + integer: 1, + long: 1000000, + double: 1.1, + bool: true, + datetime: new Date("2024-01-15T09:30:00.000Z"), + date: "2023-01-15", + uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + base64: "SGVsbG8gd29ybGQh", + list: ["string"], + set: new Set(["string"]), + map: { + 1: "string", + }, + bigint: "123456789123456789", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.PostWithObjectBody` + +
+
+ +
+
+ +**requestOptions:** `InlinedRequests.RequestOptions` + +
+
+
+
+ +
+
+
+ +## NoAuth + +
client.noAuth.postWithNoAuth({ ...params }) -> boolean +
+
+ +#### 📝 Description + +
+
+ +
+
+ +POST request with no auth + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.noAuth.postWithNoAuth({ + key: "value", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `unknown` + +
+
+ +
+
+ +**requestOptions:** `NoAuth.RequestOptions` + +
+
+
+
+ +
+
+
+ +## NoReqBody + +
client.noReqBody.getWithNoRequestBody() -> SeedExhaustive.ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.noReqBody.getWithNoRequestBody(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `NoReqBody.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.noReqBody.postWithNoRequestBody() -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.noReqBody.postWithNoRequestBody(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `NoReqBody.RequestOptions` + +
+
+
+
+ +
+
+
+ +## ReqWithHeaders + +
client.reqWithHeaders.getWithCustomHeader({ ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.reqWithHeaders.getWithCustomHeader({ + "X-TEST-SERVICE-HEADER": "string", + "X-TEST-ENDPOINT-HEADER": "string", + body: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExhaustive.ReqWithHeaders` + +
+
+ +
+
+ +**requestOptions:** `ReqWithHeaders.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/extra-properties/reference.md b/seed/ts-sdk/extra-properties/reference.md new file mode 100644 index 00000000000..d50905647e1 --- /dev/null +++ b/seed/ts-sdk/extra-properties/reference.md @@ -0,0 +1,53 @@ +# Reference + +## User + +
client.user.createUser({ ...params }) -> SeedExtraProperties.User +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.user.createUser({ + name: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedExtraProperties.CreateUserRequest` + +
+
+ +
+
+ +**requestOptions:** `User.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/file-download/file-download-reponse-headers/reference.md b/seed/ts-sdk/file-download/file-download-reponse-headers/reference.md new file mode 100644 index 00000000000..997c30105ff --- /dev/null +++ b/seed/ts-sdk/file-download/file-download-reponse-headers/reference.md @@ -0,0 +1,47 @@ +# Reference + +## Service + +
client.service.downloadFile() -> { + data: stream.Readable; + contentLengthInBytes?: number; + contentType?: string; +} +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.downloadFile(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/file-download/no-custom-config/reference.md b/seed/ts-sdk/file-download/no-custom-config/reference.md new file mode 100644 index 00000000000..c630b9f2384 --- /dev/null +++ b/seed/ts-sdk/file-download/no-custom-config/reference.md @@ -0,0 +1,43 @@ +# Reference + +## Service + +
client.service.downloadFile() -> stream.Readable +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.downloadFile(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/file-upload/no-custom-config/reference.md b/seed/ts-sdk/file-upload/no-custom-config/reference.md new file mode 100644 index 00000000000..3121630aacf --- /dev/null +++ b/seed/ts-sdk/file-upload/no-custom-config/reference.md @@ -0,0 +1,199 @@ +# Reference + +## Service + +
client.service.post(file, fileList, maybeFile, maybeFileList, { ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.post( + fs.createReadStream("/path/to/your/file"), + [fs.createReadStream("/path/to/your/file")], + fs.createReadStream("/path/to/your/file"), + [fs.createReadStream("/path/to/your/file")], + {} +); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**file:** `File | fs.ReadStream` + +
+
+ +
+
+ +**fileList:** `File[] | fs.ReadStream[]` + +
+
+ +
+
+ +**maybeFile:** `File | fs.ReadStream | undefined` + +
+
+ +
+
+ +**maybeFileList:** `File[] | fs.ReadStream[] | undefined` + +
+
+ +
+
+ +**request:** `SeedFileUpload.MyRequest` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.service.justFile(file) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.justFile(fs.createReadStream("/path/to/your/file")); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**file:** `File | fs.ReadStream` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.service.justFileWithQueryParams(file, { ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.justFileWithQueryParams(fs.createReadStream("/path/to/your/file"), { + maybeString: "string", + integer: 1, + maybeInteger: 1, + listOfStrings: "string", + optionalListOfStrings: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**file:** `File | fs.ReadStream` + +
+
+ +
+
+ +**request:** `SeedFileUpload.JustFileWithQueryParamsRequet` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/file-upload/wrap-file-properties/reference.md b/seed/ts-sdk/file-upload/wrap-file-properties/reference.md new file mode 100644 index 00000000000..df566867b59 --- /dev/null +++ b/seed/ts-sdk/file-upload/wrap-file-properties/reference.md @@ -0,0 +1,159 @@ +# Reference + +## Service + +
client.service.post({ ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.post({ + file: fs.createReadStream("/path/to/your/file"), + fileList: [fs.createReadStream("/path/to/your/file")], +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedFileUpload.MyRequest` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.service.justFile({ ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.justFile({ + file: fs.createReadStream("/path/to/your/file"), +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedFileUpload.JustFileRequet` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.service.justFileWithQueryParams({ ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.justFileWithQueryParams({ + file: fs.createReadStream("/path/to/your/file"), + maybeString: "string", + integer: 1, + maybeInteger: 1, + listOfStrings: "string", + optionalListOfStrings: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedFileUpload.JustFileWithQueryParamsRequet` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/folders/reference.md b/seed/ts-sdk/folders/reference.md new file mode 100644 index 00000000000..03ce185bcb1 --- /dev/null +++ b/seed/ts-sdk/folders/reference.md @@ -0,0 +1,261 @@ +# Reference + +
client.foo() -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.foo(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `SeedApiClient.RequestOptions` + +
+
+
+
+ +
+
+
+ +## + +## A B + +
client.a.b.foo() -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.a.b.foo(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `B.RequestOptions` + +
+
+
+
+ +
+
+
+ +## A C + +
client.a.c.foo() -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.a.c.foo(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `C.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Folder + +
client.folder.foo() -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.folder.foo(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Folder.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Folder Service + +
client.folder.service.endpoint() -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.folder.service.endpoint(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.folder.service.unknownRequest({ ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.folder.service.unknownRequest({ + key: "value", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `unknown` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/idempotency-headers/reference.md b/seed/ts-sdk/idempotency-headers/reference.md new file mode 100644 index 00000000000..9146f593a1d --- /dev/null +++ b/seed/ts-sdk/idempotency-headers/reference.md @@ -0,0 +1,102 @@ +# Reference + +## Payment + +
client.payment.create({ ...params }) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.payment.create({ + amount: 1, + currency: SeedIdempotencyHeaders.Currency.Usd, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedIdempotencyHeaders.CreatePaymentRequest` + +
+
+ +
+
+ +**requestOptions:** `Payment.IdempotentRequestOptions` + +
+
+
+
+ +
+
+
+ +
client.payment.delete(paymentId) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.payment.delete("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**paymentId:** `string` + +
+
+ +
+
+ +**requestOptions:** `Payment.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/imdb/no-custom-config/reference.md b/seed/ts-sdk/imdb/no-custom-config/reference.md new file mode 100644 index 00000000000..ddf486271dd --- /dev/null +++ b/seed/ts-sdk/imdb/no-custom-config/reference.md @@ -0,0 +1,117 @@ +# Reference + +## Imdb + +
client.imdb.createMovie({ ...params }) -> SeedApi.MovieId +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Add a movie to the database + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.imdb.createMovie({ + title: "string", + rating: 1.1, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedApi.CreateMovieRequest` + +
+
+ +
+
+ +**requestOptions:** `Imdb.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.imdb.getMovie(movieId) -> SeedApi.Movie +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.imdb.getMovie("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**movieId:** `SeedApi.MovieId` + +
+
+ +
+
+ +**requestOptions:** `Imdb.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/imdb/omit-undefined/reference.md b/seed/ts-sdk/imdb/omit-undefined/reference.md new file mode 100644 index 00000000000..ddf486271dd --- /dev/null +++ b/seed/ts-sdk/imdb/omit-undefined/reference.md @@ -0,0 +1,117 @@ +# Reference + +## Imdb + +
client.imdb.createMovie({ ...params }) -> SeedApi.MovieId +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Add a movie to the database + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.imdb.createMovie({ + title: "string", + rating: 1.1, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedApi.CreateMovieRequest` + +
+
+ +
+
+ +**requestOptions:** `Imdb.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.imdb.getMovie(movieId) -> SeedApi.Movie +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.imdb.getMovie("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**movieId:** `SeedApi.MovieId` + +
+
+ +
+
+ +**requestOptions:** `Imdb.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/literal/reference.md b/seed/ts-sdk/literal/reference.md new file mode 100644 index 00000000000..e9f165cf6c0 --- /dev/null +++ b/seed/ts-sdk/literal/reference.md @@ -0,0 +1,262 @@ +# Reference + +## Headers + +
client.headers.send({ ...params }) -> SeedLiteral.SendResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.headers.send({ + query: "What is the weather today", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedLiteral.SendLiteralsInHeadersRequest` + +
+
+ +
+
+ +**requestOptions:** `Headers.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Inlined + +
client.inlined.send({ ...params }) -> SeedLiteral.SendResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.inlined.send({ + temperature: 10.1, + query: "What is the weather today", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedLiteral.SendLiteralsInlinedRequest` + +
+
+ +
+
+ +**requestOptions:** `Inlined.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Path + +
client.path.send(id) -> SeedLiteral.SendResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.path.send("123"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `"123"` + +
+
+ +
+
+ +**requestOptions:** `Path.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Query + +
client.query.send({ ...params }) -> SeedLiteral.SendResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.query.send({ + query: "What is the weather today", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedLiteral.SendLiteralsInQueryRequest` + +
+
+ +
+
+ +**requestOptions:** `Query.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Reference + +
client.reference.send({ ...params }) -> SeedLiteral.SendResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.reference.send({ + prompt: "You are a helpful assistant", + stream: false, + query: "What is the weather today", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedLiteral.SendRequest` + +
+
+ +
+
+ +**requestOptions:** `Reference.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/mixed-case/no-custom-config/reference.md b/seed/ts-sdk/mixed-case/no-custom-config/reference.md new file mode 100644 index 00000000000..957bed7b6b5 --- /dev/null +++ b/seed/ts-sdk/mixed-case/no-custom-config/reference.md @@ -0,0 +1,102 @@ +# Reference + +## Service + +
client.service.getResource(resourceId) -> SeedMixedCase.Resource +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.getResource("rsc-xyz"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**resourceId:** `string` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.service.listResources({ ...params }) -> SeedMixedCase.Resource[] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.listResources({ + pageLimit: 10, + beforeDate: "2023-01-01", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedMixedCase.ListResourcesRequest` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/mixed-case/retain-original-casing/reference.md b/seed/ts-sdk/mixed-case/retain-original-casing/reference.md new file mode 100644 index 00000000000..a1e68174585 --- /dev/null +++ b/seed/ts-sdk/mixed-case/retain-original-casing/reference.md @@ -0,0 +1,102 @@ +# Reference + +## Service + +
client.service.getResource(ResourceID) -> SeedMixedCase.Resource +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.getResource("rsc-xyz"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**ResourceID:** `string` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.service.listResources({ ...params }) -> SeedMixedCase.Resource[] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.listResources({ + page_limit: 10, + beforeDate: "2023-01-01", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedMixedCase.ListResourcesRequest` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/multi-line-docs/reference.md b/seed/ts-sdk/multi-line-docs/reference.md new file mode 100644 index 00000000000..0ca6cea9f9e --- /dev/null +++ b/seed/ts-sdk/multi-line-docs/reference.md @@ -0,0 +1,137 @@ +# Reference + +## User + +
client.user.getUser(userId) -> void +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve a user. +This endpoint is used to retrieve a user. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.user.getUser("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**userId:** `string` + +The ID of the user to retrieve. +This ID is unique to each user. + +
+
+ +
+
+ +**requestOptions:** `User.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.user.createUser({ ...params }) -> SeedMultiLineDocs.User +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Create a new user. +This endpoint is used to create a new user. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.user.createUser({ + name: "string", + age: 1, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedMultiLineDocs.CreateUserRequest` + +
+
+ +
+
+ +**requestOptions:** `User.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/multi-url-environment-no-default/reference.md b/seed/ts-sdk/multi-url-environment-no-default/reference.md new file mode 100644 index 00000000000..d1a37e35f88 --- /dev/null +++ b/seed/ts-sdk/multi-url-environment-no-default/reference.md @@ -0,0 +1,105 @@ +# Reference + +## Ec2 + +
client.ec2.bootInstance({ ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.ec2.bootInstance({ + size: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedMultiUrlEnvironmentNoDefault.BootInstanceRequest` + +
+
+ +
+
+ +**requestOptions:** `Ec2.RequestOptions` + +
+
+
+
+ +
+
+
+ +## S3 + +
client.s3.getPresignedUrl({ ...params }) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.s3.getPresignedUrl({ + s3Key: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedMultiUrlEnvironmentNoDefault.GetPresignedUrlRequest` + +
+
+ +
+
+ +**requestOptions:** `S3.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/multi-url-environment/reference.md b/seed/ts-sdk/multi-url-environment/reference.md new file mode 100644 index 00000000000..8088d3d9d72 --- /dev/null +++ b/seed/ts-sdk/multi-url-environment/reference.md @@ -0,0 +1,105 @@ +# Reference + +## Ec2 + +
client.ec2.bootInstance({ ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.ec2.bootInstance({ + size: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedMultiUrlEnvironment.BootInstanceRequest` + +
+
+ +
+
+ +**requestOptions:** `Ec2.RequestOptions` + +
+
+
+
+ +
+
+
+ +## S3 + +
client.s3.getPresignedUrl({ ...params }) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.s3.getPresignedUrl({ + s3Key: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedMultiUrlEnvironment.GetPresignedUrlRequest` + +
+
+ +
+
+ +**requestOptions:** `S3.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/no-environment/reference.md b/seed/ts-sdk/no-environment/reference.md new file mode 100644 index 00000000000..e6b8091e3e7 --- /dev/null +++ b/seed/ts-sdk/no-environment/reference.md @@ -0,0 +1,43 @@ +# Reference + +## Dummy + +
client.dummy.getDummy() -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.dummy.getDummy(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Dummy.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/oauth-client-credentials-default/reference.md b/seed/ts-sdk/oauth-client-credentials-default/reference.md new file mode 100644 index 00000000000..ad3d132b71d --- /dev/null +++ b/seed/ts-sdk/oauth-client-credentials-default/reference.md @@ -0,0 +1,54 @@ +# Reference + +## Auth + +
client.auth.getToken({ ...params }) -> SeedOauthClientCredentialsDefault.TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.auth.getToken({ + clientId: "string", + clientSecret: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedOauthClientCredentialsDefault.GetTokenRequest` + +
+
+ +
+
+ +**requestOptions:** `Auth.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/oauth-client-credentials-environment-variables/reference.md b/seed/ts-sdk/oauth-client-credentials-environment-variables/reference.md new file mode 100644 index 00000000000..0e21bb5548a --- /dev/null +++ b/seed/ts-sdk/oauth-client-credentials-environment-variables/reference.md @@ -0,0 +1,108 @@ +# Reference + +## Auth + +
client.auth.getTokenWithClientCredentials({ ...params }) -> SeedOauthClientCredentialsEnvironmentVariables.TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.auth.getTokenWithClientCredentials({ + clientId: "string", + clientSecret: "string", + scope: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedOauthClientCredentialsEnvironmentVariables.GetTokenRequest` + +
+
+ +
+
+ +**requestOptions:** `Auth.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.auth.refreshToken({ ...params }) -> SeedOauthClientCredentialsEnvironmentVariables.TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.auth.refreshToken({ + clientId: "string", + clientSecret: "string", + refreshToken: "string", + scope: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedOauthClientCredentialsEnvironmentVariables.RefreshTokenRequest` + +
+
+ +
+
+ +**requestOptions:** `Auth.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/oauth-client-credentials-nested-root/never-throw-errors/reference.md b/seed/ts-sdk/oauth-client-credentials-nested-root/never-throw-errors/reference.md new file mode 100644 index 00000000000..9b868ee83a1 --- /dev/null +++ b/seed/ts-sdk/oauth-client-credentials-nested-root/never-throw-errors/reference.md @@ -0,0 +1,55 @@ +# Reference + +## Auth + +
client.auth.getToken({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.auth.getToken({ + clientId: "string", + clientSecret: "string", + scope: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedOauthClientCredentials.auth.GetTokenRequest` + +
+
+ +
+
+ +**requestOptions:** `Auth.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/oauth-client-credentials-nested-root/no-custom-config/reference.md b/seed/ts-sdk/oauth-client-credentials-nested-root/no-custom-config/reference.md new file mode 100644 index 00000000000..4369384aee0 --- /dev/null +++ b/seed/ts-sdk/oauth-client-credentials-nested-root/no-custom-config/reference.md @@ -0,0 +1,55 @@ +# Reference + +## Auth + +
client.auth.getToken({ ...params }) -> SeedOauthClientCredentials.TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.auth.getToken({ + clientId: "string", + clientSecret: "string", + scope: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedOauthClientCredentials.auth.GetTokenRequest` + +
+
+ +
+
+ +**requestOptions:** `Auth.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/oauth-client-credentials/reference.md b/seed/ts-sdk/oauth-client-credentials/reference.md new file mode 100644 index 00000000000..4f1b7b0020b --- /dev/null +++ b/seed/ts-sdk/oauth-client-credentials/reference.md @@ -0,0 +1,108 @@ +# Reference + +## Auth + +
client.auth.getTokenWithClientCredentials({ ...params }) -> SeedOauthClientCredentials.TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.auth.getTokenWithClientCredentials({ + clientId: "string", + clientSecret: "string", + scope: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedOauthClientCredentials.GetTokenRequest` + +
+
+ +
+
+ +**requestOptions:** `Auth.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.auth.refreshToken({ ...params }) -> SeedOauthClientCredentials.TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.auth.refreshToken({ + clientId: "string", + clientSecret: "string", + refreshToken: "string", + scope: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedOauthClientCredentials.RefreshTokenRequest` + +
+
+ +
+
+ +**requestOptions:** `Auth.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/optional/reference.md b/seed/ts-sdk/optional/reference.md new file mode 100644 index 00000000000..8c864182153 --- /dev/null +++ b/seed/ts-sdk/optional/reference.md @@ -0,0 +1,55 @@ +# Reference + +## Optional + +
client.optional.sendOptionalBody({ ...params }) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.optional.sendOptionalBody({ + string: { + key: "value", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Record` + +
+
+ +
+
+ +**requestOptions:** `Optional.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/package-yml/reference.md b/seed/ts-sdk/package-yml/reference.md new file mode 100644 index 00000000000..b310f90cc31 --- /dev/null +++ b/seed/ts-sdk/package-yml/reference.md @@ -0,0 +1,104 @@ +# Reference + +
client.echo({ ...params }) -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.echo({ + name: "Hello world!", + size: 20, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedPackageYml.EchoRequest` + +
+
+ +
+
+ +**requestOptions:** `SeedPackageYmlClient.RequestOptions` + +
+
+
+
+ +
+
+
+ +## + +## Service + +
client.service.nop(nestedId) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.nop("id-219xca8"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**nestedId:** `string` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/pagination/reference.md b/seed/ts-sdk/pagination/reference.md new file mode 100644 index 00000000000..72e4f2e18b7 --- /dev/null +++ b/seed/ts-sdk/pagination/reference.md @@ -0,0 +1,415 @@ +# Reference + +## Users + +
client.users.listWithCursorPagination({ ...params }) -> core.Page +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.users.listWithCursorPagination({ + page: 1, + perPage: 1, + order: SeedPagination.Order.Asc, + startingAfter: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedPagination.ListUsersCursorPaginationRequest` + +
+
+ +
+
+ +**requestOptions:** `Users.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.users.listWithBodyCursorPagination({ ...params }) -> core.Page +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.users.listWithBodyCursorPagination({ + pagination: { + cursor: "string", + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedPagination.ListUsersBodyCursorPaginationRequest` + +
+
+ +
+
+ +**requestOptions:** `Users.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.users.listWithOffsetPagination({ ...params }) -> core.Page +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.users.listWithOffsetPagination({ + page: 1, + perPage: 1, + order: SeedPagination.Order.Asc, + startingAfter: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedPagination.ListUsersOffsetPaginationRequest` + +
+
+ +
+
+ +**requestOptions:** `Users.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.users.listWithBodyOffsetPagination({ ...params }) -> core.Page +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.users.listWithBodyOffsetPagination({ + pagination: { + page: 1, + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedPagination.ListUsersBodyOffsetPaginationRequest` + +
+
+ +
+
+ +**requestOptions:** `Users.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.users.listWithOffsetStepPagination({ ...params }) -> core.Page +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.users.listWithOffsetStepPagination({ + page: 1, + limit: 1, + order: SeedPagination.Order.Asc, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedPagination.ListUsersOffsetStepPaginationRequest` + +
+
+ +
+
+ +**requestOptions:** `Users.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.users.listWithExtendedResults({ ...params }) -> core.Page +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.users.listWithExtendedResults({ + cursor: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedPagination.ListUsersExtendedRequest` + +
+
+ +
+
+ +**requestOptions:** `Users.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.users.listUsernames({ ...params }) -> core.Page +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.users.listUsernames({ + startingAfter: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedPagination.ListUsernamesRequest` + +
+
+ +
+
+ +**requestOptions:** `Users.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.users.listWithGlobalConfig({ ...params }) -> core.Page +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.users.listWithGlobalConfig({ + offset: 1, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedPagination.ListWithGlobalConfigRequest` + +
+
+ +
+
+ +**requestOptions:** `Users.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/plain-text/reference.md b/seed/ts-sdk/plain-text/reference.md new file mode 100644 index 00000000000..ff23971210c --- /dev/null +++ b/seed/ts-sdk/plain-text/reference.md @@ -0,0 +1,43 @@ +# Reference + +## Service + +
client.service.getText() -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.getText(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/query-parameters/no-custom-config/reference.md b/seed/ts-sdk/query-parameters/no-custom-config/reference.md new file mode 100644 index 00000000000..ac4dcd55634 --- /dev/null +++ b/seed/ts-sdk/query-parameters/no-custom-config/reference.md @@ -0,0 +1,88 @@ +# Reference + +## User + +
client.user.getUsername({ ...params }) -> SeedQueryParameters.User +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.user.getUsername({ + limit: 1, + id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + date: "2023-01-15", + deadline: new Date("2024-01-15T09:30:00.000Z"), + bytes: "SGVsbG8gd29ybGQh", + user: { + name: "string", + tags: ["string"], + }, + userList: [ + { + name: "string", + tags: ["string"], + }, + ], + optionalDeadline: new Date("2024-01-15T09:30:00.000Z"), + keyValue: { + string: "string", + }, + optionalString: "string", + nestedUser: { + name: "string", + user: { + name: "string", + tags: ["string"], + }, + }, + optionalUser: { + name: "string", + tags: ["string"], + }, + excludeUser: { + name: "string", + tags: ["string"], + }, + filter: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedQueryParameters.GetUsersRequest` + +
+
+ +
+
+ +**requestOptions:** `User.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/query-parameters/no-serde-layer-query/reference.md b/seed/ts-sdk/query-parameters/no-serde-layer-query/reference.md new file mode 100644 index 00000000000..ac4dcd55634 --- /dev/null +++ b/seed/ts-sdk/query-parameters/no-serde-layer-query/reference.md @@ -0,0 +1,88 @@ +# Reference + +## User + +
client.user.getUsername({ ...params }) -> SeedQueryParameters.User +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.user.getUsername({ + limit: 1, + id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + date: "2023-01-15", + deadline: new Date("2024-01-15T09:30:00.000Z"), + bytes: "SGVsbG8gd29ybGQh", + user: { + name: "string", + tags: ["string"], + }, + userList: [ + { + name: "string", + tags: ["string"], + }, + ], + optionalDeadline: new Date("2024-01-15T09:30:00.000Z"), + keyValue: { + string: "string", + }, + optionalString: "string", + nestedUser: { + name: "string", + user: { + name: "string", + tags: ["string"], + }, + }, + optionalUser: { + name: "string", + tags: ["string"], + }, + excludeUser: { + name: "string", + tags: ["string"], + }, + filter: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedQueryParameters.GetUsersRequest` + +
+
+ +
+
+ +**requestOptions:** `User.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/reserved-keywords/.mock/definition/.package.yml.swp b/seed/ts-sdk/reserved-keywords/.mock/definition/.package.yml.swp new file mode 100644 index 00000000000..c924d7d3248 Binary files /dev/null and b/seed/ts-sdk/reserved-keywords/.mock/definition/.package.yml.swp differ diff --git a/seed/ts-sdk/reserved-keywords/reference.md b/seed/ts-sdk/reserved-keywords/reference.md new file mode 100644 index 00000000000..c2a9e8afe1f --- /dev/null +++ b/seed/ts-sdk/reserved-keywords/reference.md @@ -0,0 +1,53 @@ +# Reference + +## Package + +
client.package.test({ ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.package.test({ + for: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedNurseryApi.TestRequest` + +
+
+ +
+
+ +**requestOptions:** `Package.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/response-property/reference.md b/seed/ts-sdk/response-property/reference.md new file mode 100644 index 00000000000..5a5d425e596 --- /dev/null +++ b/seed/ts-sdk/response-property/reference.md @@ -0,0 +1,339 @@ +# Reference + +## Service + +
client.service.getMovie({ ...params }) -> SeedResponseProperty.Response +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.getMovie("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.service.getMovieDocs({ ...params }) -> SeedResponseProperty.Response +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.getMovieDocs("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.service.getMovieName({ ...params }) -> SeedResponseProperty.StringResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.getMovieName("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.service.getMovieMetadata({ ...params }) -> SeedResponseProperty.Response +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.getMovieMetadata("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.service.getOptionalMovie({ ...params }) -> SeedResponseProperty.Response | undefined +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.getOptionalMovie("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.service.getOptionalMovieDocs({ ...params }) -> SeedResponseProperty.OptionalWithDocs | undefined +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.getOptionalMovieDocs("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.service.getOptionalMovieName({ ...params }) -> SeedResponseProperty.OptionalStringResponse | undefined +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.getOptionalMovieName("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `string` + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/server-sent-events/reference.md b/seed/ts-sdk/server-sent-events/reference.md new file mode 100644 index 00000000000..263aa7c2517 --- /dev/null +++ b/seed/ts-sdk/server-sent-events/reference.md @@ -0,0 +1,53 @@ +# Reference + +## Completions + +
client.completions.stream({ ...params }) -> core.Stream +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.completions.stream({ + query: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedServerSentEvents.StreamCompletionRequest` + +
+
+ +
+
+ +**requestOptions:** `Completions.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/single-url-environment-default/reference.md b/seed/ts-sdk/single-url-environment-default/reference.md new file mode 100644 index 00000000000..e6b8091e3e7 --- /dev/null +++ b/seed/ts-sdk/single-url-environment-default/reference.md @@ -0,0 +1,43 @@ +# Reference + +## Dummy + +
client.dummy.getDummy() -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.dummy.getDummy(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Dummy.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/single-url-environment-no-default/reference.md b/seed/ts-sdk/single-url-environment-no-default/reference.md new file mode 100644 index 00000000000..e6b8091e3e7 --- /dev/null +++ b/seed/ts-sdk/single-url-environment-no-default/reference.md @@ -0,0 +1,43 @@ +# Reference + +## Dummy + +
client.dummy.getDummy() -> string +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.dummy.getDummy(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Dummy.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/streaming/allow-custom-fetcher/reference.md b/seed/ts-sdk/streaming/allow-custom-fetcher/reference.md new file mode 100644 index 00000000000..1f8cbd21140 --- /dev/null +++ b/seed/ts-sdk/streaming/allow-custom-fetcher/reference.md @@ -0,0 +1,103 @@ +# Reference + +## Dummy + +
client.dummy.generateStream({ ...params }) -> core.Stream +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.dummy.generateStream({ + numEvents: 1, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedStreaming.GenerateStreamRequest` + +
+
+ +
+
+ +**requestOptions:** `Dummy.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.dummy.generate({ ...params }) -> SeedStreaming.StreamResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.dummy.generate({ + numEvents: 5, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedStreaming.Generateequest` + +
+
+ +
+
+ +**requestOptions:** `Dummy.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/streaming/no-custom-config/reference.md b/seed/ts-sdk/streaming/no-custom-config/reference.md new file mode 100644 index 00000000000..1f8cbd21140 --- /dev/null +++ b/seed/ts-sdk/streaming/no-custom-config/reference.md @@ -0,0 +1,103 @@ +# Reference + +## Dummy + +
client.dummy.generateStream({ ...params }) -> core.Stream +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.dummy.generateStream({ + numEvents: 1, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedStreaming.GenerateStreamRequest` + +
+
+ +
+
+ +**requestOptions:** `Dummy.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.dummy.generate({ ...params }) -> SeedStreaming.StreamResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.dummy.generate({ + numEvents: 5, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedStreaming.Generateequest` + +
+
+ +
+
+ +**requestOptions:** `Dummy.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/trace/exhaustive/reference.md b/seed/ts-sdk/trace/exhaustive/reference.md new file mode 100644 index 00000000000..694f803d0ed --- /dev/null +++ b/seed/ts-sdk/trace/exhaustive/reference.md @@ -0,0 +1,2263 @@ +# Reference + +## V2 + +
client.v2.test() -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.test(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `V2.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Admin + +
client.admin.updateTestSubmissionStatus(submissionId, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.updateTestSubmissionStatus( + SeedTrace.SubmissionId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), + SeedTrace.TestSubmissionStatus.stopped() +); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.TestSubmissionStatus` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.sendTestSubmissionUpdate(submissionId, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.sendTestSubmissionUpdate(SeedTrace.SubmissionId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), { + updateTime: new Date("2024-01-15T09:30:00.000Z"), + updateInfo: SeedTrace.TestSubmissionUpdateInfo.running(SeedTrace.RunningSubmissionState.QueueingSubmission), +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.TestSubmissionUpdate` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.updateWorkspaceSubmissionStatus(submissionId, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.updateWorkspaceSubmissionStatus( + SeedTrace.SubmissionId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), + SeedTrace.WorkspaceSubmissionStatus.stopped() +); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.WorkspaceSubmissionStatus` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.sendWorkspaceSubmissionUpdate(submissionId, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.sendWorkspaceSubmissionUpdate(SeedTrace.SubmissionId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), { + updateTime: new Date("2024-01-15T09:30:00.000Z"), + updateInfo: SeedTrace.WorkspaceSubmissionUpdateInfo.running(SeedTrace.RunningSubmissionState.QueueingSubmission), +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.WorkspaceSubmissionUpdate` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.storeTracedTestCase(submissionId, testCaseId, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.storeTracedTestCase(SeedTrace.SubmissionId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), "string", { + result: { + result: {}, + stdout: "string", + }, + traceResponses: [ + { + submissionId: SeedTrace.SubmissionId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), + lineNumber: 1, + returnValue: SeedTrace.DebugVariableValue.integerValue(1), + expressionLocation: {}, + stack: {}, + stdout: "string", + }, + ], +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**testCaseId:** `string` + +
+
+ +
+
+ +**request:** `SeedTrace.StoreTracedTestCaseRequest` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.storeTracedTestCaseV2(submissionId, testCaseId, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.storeTracedTestCaseV2( + SeedTrace.SubmissionId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), + SeedTrace.TestCaseId("string"), + [ + { + submissionId: SeedTrace.SubmissionId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), + lineNumber: 1, + file: {}, + returnValue: SeedTrace.DebugVariableValue.integerValue(1), + expressionLocation: {}, + stack: {}, + stdout: "string", + }, + ] +); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**testCaseId:** `SeedTrace.TestCaseId` + +
+
+ +
+
+ +**request:** `SeedTrace.TraceResponseV2[]` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.storeTracedWorkspace(submissionId, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.storeTracedWorkspace(SeedTrace.SubmissionId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), { + workspaceRunDetails: { + exceptionV2: SeedTrace.ExceptionV2.generic({}), + exception: {}, + stdout: "string", + }, + traceResponses: [ + { + submissionId: SeedTrace.SubmissionId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), + lineNumber: 1, + returnValue: SeedTrace.DebugVariableValue.integerValue(1), + expressionLocation: {}, + stack: {}, + stdout: "string", + }, + ], +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.StoreTracedWorkspaceRequest` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.storeTracedWorkspaceV2(submissionId, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.storeTracedWorkspaceV2(SeedTrace.SubmissionId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), [ + { + submissionId: SeedTrace.SubmissionId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), + lineNumber: 1, + file: {}, + returnValue: SeedTrace.DebugVariableValue.integerValue(1), + expressionLocation: {}, + stack: {}, + stdout: "string", + }, +]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.TraceResponseV2[]` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Homepage + +
client.homepage.getHomepageProblems() -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.homepage.getHomepageProblems(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Homepage.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.homepage.setHomepageProblems({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.homepage.setHomepageProblems([SeedTrace.ProblemId("string")]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedTrace.ProblemId[]` + +
+
+ +
+
+ +**requestOptions:** `Homepage.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Migration + +
client.migration.getAttemptedMigrations({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.migration.getAttemptedMigrations({ + adminKeyHeader: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedTrace.GetAttemptedMigrationsRequest` + +
+
+ +
+
+ +**requestOptions:** `Migration.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Playlist + +
client.playlist.createPlaylist(serviceParam, { ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Create a new playlist + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.playlist.createPlaylist(1, { + datetime: new Date("2024-01-15T09:30:00.000Z"), + optionalDatetime: new Date("2024-01-15T09:30:00.000Z"), + body: { + name: "string", + problems: [SeedTrace.ProblemId("string")], + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `number` + +
+
+ +
+
+ +**request:** `SeedTrace.CreatePlaylistRequest` + +
+
+ +
+
+ +**requestOptions:** `Playlist.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.playlist.getPlaylists(serviceParam, { ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the user's playlists + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.playlist.getPlaylists(1, { + limit: 1, + otherField: "string", + multiLineDocs: "string", + optionalMultipleField: "string", + multipleField: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `number` + +
+
+ +
+
+ +**request:** `SeedTrace.GetPlaylistsRequest` + +
+
+ +
+
+ +**requestOptions:** `Playlist.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.playlist.getPlaylist(serviceParam, playlistId) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a playlist + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.playlist.getPlaylist(1, SeedTrace.PlaylistId("string")); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `number` + +
+
+ +
+
+ +**playlistId:** `SeedTrace.PlaylistId` + +
+
+ +
+
+ +**requestOptions:** `Playlist.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.playlist.updatePlaylist(serviceParam, playlistId, { ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a playlist + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.playlist.updatePlaylist(1, SeedTrace.PlaylistId("string"), { + name: "string", + problems: [SeedTrace.ProblemId("string")], +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `number` + +
+
+ +
+
+ +**playlistId:** `SeedTrace.PlaylistId` + +
+
+ +
+
+ +**request:** `SeedTrace.UpdatePlaylistRequest` + +
+
+ +
+
+ +**requestOptions:** `Playlist.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.playlist.deletePlaylist(serviceParam, playlistId) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a playlist + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.playlist.deletePlaylist(1, SeedTrace.PlaylistId("string")); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `number` + +
+
+ +
+
+ +**playlistId:** `SeedTrace.PlaylistId` + +
+
+ +
+
+ +**requestOptions:** `Playlist.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Problem + +
client.problem.createProblem({ ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.problem.createProblem({ + problemName: "string", + problemDescription: { + boards: [SeedTrace.ProblemDescriptionBoard.html("string")], + }, + files: { + [SeedTrace.Language.Java]: { + solutionFile: { + filename: "string", + contents: "string", + }, + readOnlyFiles: [ + { + filename: "string", + contents: "string", + }, + ], + }, + }, + inputParams: [ + { + variableType: SeedTrace.VariableType.integerType(), + name: "string", + }, + ], + outputType: SeedTrace.VariableType.integerType(), + testcases: [ + { + testCase: { + id: "string", + params: [SeedTrace.VariableValue.integerValue(1)], + }, + expectedResult: SeedTrace.VariableValue.integerValue(1), + }, + ], + methodName: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedTrace.CreateProblemRequest` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.problem.updateProblem(problemId, { ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.problem.updateProblem(SeedTrace.ProblemId("string"), { + problemName: "string", + problemDescription: { + boards: [SeedTrace.ProblemDescriptionBoard.html("string")], + }, + files: { + [SeedTrace.Language.Java]: { + solutionFile: { + filename: "string", + contents: "string", + }, + readOnlyFiles: [ + { + filename: "string", + contents: "string", + }, + ], + }, + }, + inputParams: [ + { + variableType: SeedTrace.VariableType.integerType(), + name: "string", + }, + ], + outputType: SeedTrace.VariableType.integerType(), + testcases: [ + { + testCase: { + id: "string", + params: [SeedTrace.VariableValue.integerValue(1)], + }, + expectedResult: SeedTrace.VariableValue.integerValue(1), + }, + ], + methodName: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**request:** `SeedTrace.CreateProblemRequest` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.problem.deleteProblem(problemId) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Soft deletes a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.problem.deleteProblem(SeedTrace.ProblemId("string")); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.problem.getDefaultStarterFiles({ ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns default starter files for problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.problem.getDefaultStarterFiles({ + inputParams: [ + { + variableType: SeedTrace.VariableType.integerType(), + name: "string", + }, + ], + outputType: SeedTrace.VariableType.integerType(), + methodName: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedTrace.GetDefaultStarterFilesRequest` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Submission + +
client.submission.createExecutionSession(language) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns sessionId and execution server URL for session. Spins up server. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.submission.createExecutionSession(SeedTrace.Language.Java); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**language:** `SeedTrace.Language` + +
+
+ +
+
+ +**requestOptions:** `Submission.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.submission.getExecutionSession(sessionId) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns execution server URL for session. Returns empty if session isn't registered. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.submission.getExecutionSession("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**sessionId:** `string` + +
+
+ +
+
+ +**requestOptions:** `Submission.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.submission.stopExecutionSession(sessionId) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Stops execution session. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.submission.stopExecutionSession("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**sessionId:** `string` + +
+
+ +
+
+ +**requestOptions:** `Submission.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.submission.getExecutionSessionsState() -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.submission.getExecutionSessionsState(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Submission.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Sysprop + +
client.sysprop.setNumWarmInstances(language, numWarmInstances) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.sysprop.setNumWarmInstances(SeedTrace.Language.Java, 1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**language:** `SeedTrace.Language` + +
+
+ +
+
+ +**numWarmInstances:** `number` + +
+
+ +
+
+ +**requestOptions:** `Sysprop.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.sysprop.getNumWarmInstances() -> core.APIResponse, SeedTrace.sysprop.getNumWarmInstances.Error> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.sysprop.getNumWarmInstances(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Sysprop.RequestOptions` + +
+
+
+
+ +
+
+
+ +## V2 Problem + +
client.v2.problem.getLightweightProblems() -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns lightweight versions of all problems + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.problem.getLightweightProblems(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.problem.getProblems() -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns latest versions of all problems + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.problem.getProblems(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.problem.getLatestProblem(problemId) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns latest version of a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.problem.getLatestProblem(SeedTrace.ProblemId("string")); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.problem.getProblemVersion(problemId, problemVersion) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns requested version of a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.problem.getProblemVersion(SeedTrace.ProblemId("string"), 1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**problemVersion:** `number` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +## V2 V3 Problem + +
client.v2.v3.problem.getLightweightProblems() -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns lightweight versions of all problems + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.v3.problem.getLightweightProblems(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.v3.problem.getProblems() -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns latest versions of all problems + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.v3.problem.getProblems(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.v3.problem.getLatestProblem(problemId) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns latest version of a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.v3.problem.getLatestProblem(SeedTrace.ProblemId("string")); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.v3.problem.getProblemVersion(problemId, problemVersion) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns requested version of a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.v3.problem.getProblemVersion(SeedTrace.ProblemId("string"), 1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**problemVersion:** `number` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/trace/no-custom-config/reference.md b/seed/ts-sdk/trace/no-custom-config/reference.md new file mode 100644 index 00000000000..a9e73ca13c2 --- /dev/null +++ b/seed/ts-sdk/trace/no-custom-config/reference.md @@ -0,0 +1,2315 @@ +# Reference + +## V2 + +
client.v2.test() -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.test(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `V2.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Admin + +
client.admin.updateTestSubmissionStatus(submissionId, { ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.updateTestSubmissionStatus("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", { + type: "stopped", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.TestSubmissionStatus` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.sendTestSubmissionUpdate(submissionId, { ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.sendTestSubmissionUpdate("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", { + updateTime: new Date("2024-01-15T09:30:00.000Z"), + updateInfo: { + type: "running", + value: SeedTrace.RunningSubmissionState.QueueingSubmission, + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.TestSubmissionUpdate` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.updateWorkspaceSubmissionStatus(submissionId, { ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.updateWorkspaceSubmissionStatus("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", { + type: "stopped", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.WorkspaceSubmissionStatus` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.sendWorkspaceSubmissionUpdate(submissionId, { ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.sendWorkspaceSubmissionUpdate("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", { + updateTime: new Date("2024-01-15T09:30:00.000Z"), + updateInfo: { + type: "running", + value: SeedTrace.RunningSubmissionState.QueueingSubmission, + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.WorkspaceSubmissionUpdate` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.storeTracedTestCase(submissionId, testCaseId, { ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.storeTracedTestCase("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "string", { + result: { + result: {}, + stdout: "string", + }, + traceResponses: [ + { + submissionId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + lineNumber: 1, + returnValue: { + type: "integerValue", + value: 1, + }, + expressionLocation: {}, + stack: {}, + stdout: "string", + }, + ], +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**testCaseId:** `string` + +
+
+ +
+
+ +**request:** `SeedTrace.StoreTracedTestCaseRequest` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.storeTracedTestCaseV2(submissionId, testCaseId, { ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.storeTracedTestCaseV2("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "string", [ + { + submissionId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + lineNumber: 1, + file: {}, + returnValue: { + type: "integerValue", + value: 1, + }, + expressionLocation: {}, + stack: {}, + stdout: "string", + }, +]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**testCaseId:** `SeedTrace.TestCaseId` + +
+
+ +
+
+ +**request:** `SeedTrace.TraceResponseV2[]` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.storeTracedWorkspace(submissionId, { ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.storeTracedWorkspace("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", { + workspaceRunDetails: { + exceptionV2: { + type: "generic", + }, + exception: {}, + stdout: "string", + }, + traceResponses: [ + { + submissionId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + lineNumber: 1, + returnValue: { + type: "integerValue", + value: 1, + }, + expressionLocation: {}, + stack: {}, + stdout: "string", + }, + ], +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.StoreTracedWorkspaceRequest` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.storeTracedWorkspaceV2(submissionId, { ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.storeTracedWorkspaceV2("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", [ + { + submissionId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + lineNumber: 1, + file: {}, + returnValue: { + type: "integerValue", + value: 1, + }, + expressionLocation: {}, + stack: {}, + stdout: "string", + }, +]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.TraceResponseV2[]` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Homepage + +
client.homepage.getHomepageProblems() -> SeedTrace.ProblemId[] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.homepage.getHomepageProblems(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Homepage.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.homepage.setHomepageProblems({ ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.homepage.setHomepageProblems(["string"]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedTrace.ProblemId[]` + +
+
+ +
+
+ +**requestOptions:** `Homepage.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Migration + +
client.migration.getAttemptedMigrations({ ...params }) -> SeedTrace.Migration[] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.migration.getAttemptedMigrations({ + adminKeyHeader: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedTrace.GetAttemptedMigrationsRequest` + +
+
+ +
+
+ +**requestOptions:** `Migration.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Playlist + +
client.playlist.createPlaylist(serviceParam, { ...params }) -> SeedTrace.Playlist +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Create a new playlist + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.playlist.createPlaylist(1, { + datetime: new Date("2024-01-15T09:30:00.000Z"), + optionalDatetime: new Date("2024-01-15T09:30:00.000Z"), + body: { + name: "string", + problems: ["string"], + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `number` + +
+
+ +
+
+ +**request:** `SeedTrace.CreatePlaylistRequest` + +
+
+ +
+
+ +**requestOptions:** `Playlist.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.playlist.getPlaylists(serviceParam, { ...params }) -> SeedTrace.Playlist[] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the user's playlists + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.playlist.getPlaylists(1, { + limit: 1, + otherField: "string", + multiLineDocs: "string", + optionalMultipleField: "string", + multipleField: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `number` + +
+
+ +
+
+ +**request:** `SeedTrace.GetPlaylistsRequest` + +
+
+ +
+
+ +**requestOptions:** `Playlist.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.playlist.getPlaylist(serviceParam, playlistId) -> SeedTrace.Playlist +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a playlist + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.playlist.getPlaylist(1, "string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `number` + +
+
+ +
+
+ +**playlistId:** `SeedTrace.PlaylistId` + +
+
+ +
+
+ +**requestOptions:** `Playlist.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.playlist.updatePlaylist(serviceParam, playlistId, { ...params }) -> SeedTrace.Playlist | undefined +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a playlist + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.playlist.updatePlaylist(1, "string", { + name: "string", + problems: ["string"], +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `number` + +
+
+ +
+
+ +**playlistId:** `SeedTrace.PlaylistId` + +
+
+ +
+
+ +**request:** `SeedTrace.UpdatePlaylistRequest` + +
+
+ +
+
+ +**requestOptions:** `Playlist.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.playlist.deletePlaylist(serviceParam, playlistId) -> void +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a playlist + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.playlist.deletePlaylist(1, "string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `number` + +
+
+ +
+
+ +**playlistId:** `SeedTrace.PlaylistId` + +
+
+ +
+
+ +**requestOptions:** `Playlist.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Problem + +
client.problem.createProblem({ ...params }) -> SeedTrace.CreateProblemResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.problem.createProblem({ + problemName: "string", + problemDescription: { + boards: [ + { + type: "html", + value: "string", + }, + ], + }, + files: { + [SeedTrace.Language.Java]: { + solutionFile: { + filename: "string", + contents: "string", + }, + readOnlyFiles: [ + { + filename: "string", + contents: "string", + }, + ], + }, + }, + inputParams: [ + { + variableType: { + type: "integerType", + }, + name: "string", + }, + ], + outputType: { + type: "integerType", + }, + testcases: [ + { + testCase: { + id: "string", + params: [ + { + type: "integerValue", + value: 1, + }, + ], + }, + expectedResult: { + type: "integerValue", + value: 1, + }, + }, + ], + methodName: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedTrace.CreateProblemRequest` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.problem.updateProblem(problemId, { ...params }) -> SeedTrace.UpdateProblemResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.problem.updateProblem("string", { + problemName: "string", + problemDescription: { + boards: [ + { + type: "html", + value: "string", + }, + ], + }, + files: { + [SeedTrace.Language.Java]: { + solutionFile: { + filename: "string", + contents: "string", + }, + readOnlyFiles: [ + { + filename: "string", + contents: "string", + }, + ], + }, + }, + inputParams: [ + { + variableType: { + type: "integerType", + }, + name: "string", + }, + ], + outputType: { + type: "integerType", + }, + testcases: [ + { + testCase: { + id: "string", + params: [ + { + type: "integerValue", + value: 1, + }, + ], + }, + expectedResult: { + type: "integerValue", + value: 1, + }, + }, + ], + methodName: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**request:** `SeedTrace.CreateProblemRequest` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.problem.deleteProblem(problemId) -> void +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Soft deletes a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.problem.deleteProblem("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.problem.getDefaultStarterFiles({ ...params }) -> SeedTrace.GetDefaultStarterFilesResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns default starter files for problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.problem.getDefaultStarterFiles({ + inputParams: [ + { + variableType: { + type: "integerType", + }, + name: "string", + }, + ], + outputType: { + type: "integerType", + }, + methodName: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedTrace.GetDefaultStarterFilesRequest` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Submission + +
client.submission.createExecutionSession(language) -> SeedTrace.ExecutionSessionResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns sessionId and execution server URL for session. Spins up server. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.submission.createExecutionSession(SeedTrace.Language.Java); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**language:** `SeedTrace.Language` + +
+
+ +
+
+ +**requestOptions:** `Submission.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.submission.getExecutionSession(sessionId) -> SeedTrace.ExecutionSessionResponse | undefined +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns execution server URL for session. Returns empty if session isn't registered. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.submission.getExecutionSession("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**sessionId:** `string` + +
+
+ +
+
+ +**requestOptions:** `Submission.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.submission.stopExecutionSession(sessionId) -> void +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Stops execution session. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.submission.stopExecutionSession("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**sessionId:** `string` + +
+
+ +
+
+ +**requestOptions:** `Submission.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.submission.getExecutionSessionsState() -> SeedTrace.GetExecutionSessionStateResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.submission.getExecutionSessionsState(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Submission.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Sysprop + +
client.sysprop.setNumWarmInstances(language, numWarmInstances) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.sysprop.setNumWarmInstances(SeedTrace.Language.Java, 1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**language:** `SeedTrace.Language` + +
+
+ +
+
+ +**numWarmInstances:** `number` + +
+
+ +
+
+ +**requestOptions:** `Sysprop.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.sysprop.getNumWarmInstances() -> Record +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.sysprop.getNumWarmInstances(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Sysprop.RequestOptions` + +
+
+
+
+ +
+
+
+ +## V2 Problem + +
client.v2.problem.getLightweightProblems() -> SeedTrace.LightweightProblemInfoV2[] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns lightweight versions of all problems + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.problem.getLightweightProblems(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.problem.getProblems() -> SeedTrace.ProblemInfoV2[] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns latest versions of all problems + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.problem.getProblems(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.problem.getLatestProblem(problemId) -> SeedTrace.ProblemInfoV2 +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns latest version of a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.problem.getLatestProblem("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.problem.getProblemVersion(problemId, problemVersion) -> SeedTrace.ProblemInfoV2 +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns requested version of a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.problem.getProblemVersion("string", 1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**problemVersion:** `number` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +## V2 V3 Problem + +
client.v2.v3.problem.getLightweightProblems() -> SeedTrace.LightweightProblemInfoV2[] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns lightweight versions of all problems + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.v3.problem.getLightweightProblems(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.v3.problem.getProblems() -> SeedTrace.ProblemInfoV2[] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns latest versions of all problems + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.v3.problem.getProblems(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.v3.problem.getLatestProblem(problemId) -> SeedTrace.ProblemInfoV2 +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns latest version of a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.v3.problem.getLatestProblem("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.v3.problem.getProblemVersion(problemId, problemVersion) -> SeedTrace.ProblemInfoV2 +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns requested version of a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.v3.problem.getProblemVersion("string", 1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**problemVersion:** `number` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/trace/no-zurg-no-throwing/reference.md b/seed/ts-sdk/trace/no-zurg-no-throwing/reference.md new file mode 100644 index 00000000000..42b40c1de18 --- /dev/null +++ b/seed/ts-sdk/trace/no-zurg-no-throwing/reference.md @@ -0,0 +1,2315 @@ +# Reference + +## V2 + +
client.v2.test() -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.test(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `V2.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Admin + +
client.admin.updateTestSubmissionStatus(submissionId, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.updateTestSubmissionStatus("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", { + type: "stopped", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.TestSubmissionStatus` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.sendTestSubmissionUpdate(submissionId, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.sendTestSubmissionUpdate("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", { + updateTime: new Date("2024-01-15T09:30:00.000Z"), + updateInfo: { + type: "running", + value: SeedTrace.RunningSubmissionState.QueueingSubmission, + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.TestSubmissionUpdate` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.updateWorkspaceSubmissionStatus(submissionId, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.updateWorkspaceSubmissionStatus("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", { + type: "stopped", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.WorkspaceSubmissionStatus` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.sendWorkspaceSubmissionUpdate(submissionId, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.sendWorkspaceSubmissionUpdate("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", { + updateTime: new Date("2024-01-15T09:30:00.000Z"), + updateInfo: { + type: "running", + value: SeedTrace.RunningSubmissionState.QueueingSubmission, + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.WorkspaceSubmissionUpdate` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.storeTracedTestCase(submissionId, testCaseId, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.storeTracedTestCase("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "string", { + result: { + result: {}, + stdout: "string", + }, + traceResponses: [ + { + submissionId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + lineNumber: 1, + returnValue: { + type: "integerValue", + value: 1, + }, + expressionLocation: {}, + stack: {}, + stdout: "string", + }, + ], +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**testCaseId:** `string` + +
+
+ +
+
+ +**request:** `SeedTrace.StoreTracedTestCaseRequest` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.storeTracedTestCaseV2(submissionId, testCaseId, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.storeTracedTestCaseV2("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "string", [ + { + submissionId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + lineNumber: 1, + file: {}, + returnValue: { + type: "integerValue", + value: 1, + }, + expressionLocation: {}, + stack: {}, + stdout: "string", + }, +]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**testCaseId:** `SeedTrace.TestCaseId` + +
+
+ +
+
+ +**request:** `SeedTrace.TraceResponseV2[]` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.storeTracedWorkspace(submissionId, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.storeTracedWorkspace("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", { + workspaceRunDetails: { + exceptionV2: { + type: "generic", + }, + exception: {}, + stdout: "string", + }, + traceResponses: [ + { + submissionId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + lineNumber: 1, + returnValue: { + type: "integerValue", + value: 1, + }, + expressionLocation: {}, + stack: {}, + stdout: "string", + }, + ], +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.StoreTracedWorkspaceRequest` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.storeTracedWorkspaceV2(submissionId, { ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.storeTracedWorkspaceV2("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", [ + { + submissionId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + lineNumber: 1, + file: {}, + returnValue: { + type: "integerValue", + value: 1, + }, + expressionLocation: {}, + stack: {}, + stdout: "string", + }, +]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.TraceResponseV2[]` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Homepage + +
client.homepage.getHomepageProblems() -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.homepage.getHomepageProblems(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Homepage.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.homepage.setHomepageProblems({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.homepage.setHomepageProblems(["string"]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedTrace.ProblemId[]` + +
+
+ +
+
+ +**requestOptions:** `Homepage.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Migration + +
client.migration.getAttemptedMigrations({ ...params }) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.migration.getAttemptedMigrations({ + "admin-key-header": "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedTrace.GetAttemptedMigrationsRequest` + +
+
+ +
+
+ +**requestOptions:** `Migration.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Playlist + +
client.playlist.createPlaylist(serviceParam, { ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Create a new playlist + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.playlist.createPlaylist(1, { + datetime: new Date("2024-01-15T09:30:00.000Z"), + optionalDatetime: new Date("2024-01-15T09:30:00.000Z"), + body: { + name: "string", + problems: ["string"], + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `number` + +
+
+ +
+
+ +**request:** `SeedTrace.CreatePlaylistRequest` + +
+
+ +
+
+ +**requestOptions:** `Playlist.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.playlist.getPlaylists(serviceParam, { ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the user's playlists + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.playlist.getPlaylists(1, { + limit: 1, + otherField: "string", + multiLineDocs: "string", + optionalMultipleField: "string", + multipleField: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `number` + +
+
+ +
+
+ +**request:** `SeedTrace.GetPlaylistsRequest` + +
+
+ +
+
+ +**requestOptions:** `Playlist.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.playlist.getPlaylist(serviceParam, playlistId) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a playlist + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.playlist.getPlaylist(1, "string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `number` + +
+
+ +
+
+ +**playlistId:** `SeedTrace.PlaylistId` + +
+
+ +
+
+ +**requestOptions:** `Playlist.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.playlist.updatePlaylist(serviceParam, playlistId, { ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a playlist + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.playlist.updatePlaylist(1, "string", { + name: "string", + problems: ["string"], +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `number` + +
+
+ +
+
+ +**playlistId:** `SeedTrace.PlaylistId` + +
+
+ +
+
+ +**request:** `SeedTrace.UpdatePlaylistRequest` + +
+
+ +
+
+ +**requestOptions:** `Playlist.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.playlist.deletePlaylist(serviceParam, playlistId) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a playlist + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.playlist.deletePlaylist(1, "string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `number` + +
+
+ +
+
+ +**playlistId:** `SeedTrace.PlaylistId` + +
+
+ +
+
+ +**requestOptions:** `Playlist.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Problem + +
client.problem.createProblem({ ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.problem.createProblem({ + problemName: "string", + problemDescription: { + boards: [ + { + type: "html", + value: "string", + }, + ], + }, + files: { + [SeedTrace.Language.Java]: { + solutionFile: { + filename: "string", + contents: "string", + }, + readOnlyFiles: [ + { + filename: "string", + contents: "string", + }, + ], + }, + }, + inputParams: [ + { + variableType: { + type: "integerType", + }, + name: "string", + }, + ], + outputType: { + type: "integerType", + }, + testcases: [ + { + testCase: { + id: "string", + params: [ + { + type: "integerValue", + value: 1, + }, + ], + }, + expectedResult: { + type: "integerValue", + value: 1, + }, + }, + ], + methodName: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedTrace.CreateProblemRequest` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.problem.updateProblem(problemId, { ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.problem.updateProblem("string", { + problemName: "string", + problemDescription: { + boards: [ + { + type: "html", + value: "string", + }, + ], + }, + files: { + [SeedTrace.Language.Java]: { + solutionFile: { + filename: "string", + contents: "string", + }, + readOnlyFiles: [ + { + filename: "string", + contents: "string", + }, + ], + }, + }, + inputParams: [ + { + variableType: { + type: "integerType", + }, + name: "string", + }, + ], + outputType: { + type: "integerType", + }, + testcases: [ + { + testCase: { + id: "string", + params: [ + { + type: "integerValue", + value: 1, + }, + ], + }, + expectedResult: { + type: "integerValue", + value: 1, + }, + }, + ], + methodName: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**request:** `SeedTrace.CreateProblemRequest` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.problem.deleteProblem(problemId) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Soft deletes a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.problem.deleteProblem("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.problem.getDefaultStarterFiles({ ...params }) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns default starter files for problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.problem.getDefaultStarterFiles({ + inputParams: [ + { + variableType: { + type: "integerType", + }, + name: "string", + }, + ], + outputType: { + type: "integerType", + }, + methodName: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedTrace.GetDefaultStarterFilesRequest` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Submission + +
client.submission.createExecutionSession(language) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns sessionId and execution server URL for session. Spins up server. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.submission.createExecutionSession(SeedTrace.Language.Java); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**language:** `SeedTrace.Language` + +
+
+ +
+
+ +**requestOptions:** `Submission.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.submission.getExecutionSession(sessionId) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns execution server URL for session. Returns empty if session isn't registered. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.submission.getExecutionSession("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**sessionId:** `string` + +
+
+ +
+
+ +**requestOptions:** `Submission.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.submission.stopExecutionSession(sessionId) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Stops execution session. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.submission.stopExecutionSession("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**sessionId:** `string` + +
+
+ +
+
+ +**requestOptions:** `Submission.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.submission.getExecutionSessionsState() -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.submission.getExecutionSessionsState(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Submission.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Sysprop + +
client.sysprop.setNumWarmInstances(language, numWarmInstances) -> core.APIResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.sysprop.setNumWarmInstances(SeedTrace.Language.Java, 1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**language:** `SeedTrace.Language` + +
+
+ +
+
+ +**numWarmInstances:** `number` + +
+
+ +
+
+ +**requestOptions:** `Sysprop.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.sysprop.getNumWarmInstances() -> core.APIResponse, SeedTrace.sysprop.getNumWarmInstances.Error> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.sysprop.getNumWarmInstances(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Sysprop.RequestOptions` + +
+
+
+
+ +
+
+
+ +## V2 Problem + +
client.v2.problem.getLightweightProblems() -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns lightweight versions of all problems + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.problem.getLightweightProblems(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.problem.getProblems() -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns latest versions of all problems + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.problem.getProblems(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.problem.getLatestProblem(problemId) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns latest version of a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.problem.getLatestProblem("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.problem.getProblemVersion(problemId, problemVersion) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns requested version of a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.problem.getProblemVersion("string", 1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**problemVersion:** `number` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +## V2 V3 Problem + +
client.v2.v3.problem.getLightweightProblems() -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns lightweight versions of all problems + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.v3.problem.getLightweightProblems(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.v3.problem.getProblems() -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns latest versions of all problems + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.v3.problem.getProblems(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.v3.problem.getLatestProblem(problemId) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns latest version of a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.v3.problem.getLatestProblem("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.v3.problem.getProblemVersion(problemId, problemVersion) -> core.APIResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns requested version of a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.v3.problem.getProblemVersion("string", 1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**problemVersion:** `number` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/trace/no-zurg-trace/reference.md b/seed/ts-sdk/trace/no-zurg-trace/reference.md new file mode 100644 index 00000000000..595c71dce7a --- /dev/null +++ b/seed/ts-sdk/trace/no-zurg-trace/reference.md @@ -0,0 +1,2315 @@ +# Reference + +## V2 + +
client.v2.test() -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.test(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `V2.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Admin + +
client.admin.updateTestSubmissionStatus(submissionId, { ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.updateTestSubmissionStatus("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", { + type: "stopped", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.TestSubmissionStatus` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.sendTestSubmissionUpdate(submissionId, { ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.sendTestSubmissionUpdate("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", { + updateTime: new Date("2024-01-15T09:30:00.000Z"), + updateInfo: { + type: "running", + value: SeedTrace.RunningSubmissionState.QueueingSubmission, + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.TestSubmissionUpdate` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.updateWorkspaceSubmissionStatus(submissionId, { ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.updateWorkspaceSubmissionStatus("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", { + type: "stopped", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.WorkspaceSubmissionStatus` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.sendWorkspaceSubmissionUpdate(submissionId, { ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.sendWorkspaceSubmissionUpdate("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", { + updateTime: new Date("2024-01-15T09:30:00.000Z"), + updateInfo: { + type: "running", + value: SeedTrace.RunningSubmissionState.QueueingSubmission, + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.WorkspaceSubmissionUpdate` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.storeTracedTestCase(submissionId, testCaseId, { ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.storeTracedTestCase("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "string", { + result: { + result: {}, + stdout: "string", + }, + traceResponses: [ + { + submissionId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + lineNumber: 1, + returnValue: { + type: "integerValue", + value: 1, + }, + expressionLocation: {}, + stack: {}, + stdout: "string", + }, + ], +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**testCaseId:** `string` + +
+
+ +
+
+ +**request:** `SeedTrace.StoreTracedTestCaseRequest` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.storeTracedTestCaseV2(submissionId, testCaseId, { ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.storeTracedTestCaseV2("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "string", [ + { + submissionId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + lineNumber: 1, + file: {}, + returnValue: { + type: "integerValue", + value: 1, + }, + expressionLocation: {}, + stack: {}, + stdout: "string", + }, +]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**testCaseId:** `SeedTrace.TestCaseId` + +
+
+ +
+
+ +**request:** `SeedTrace.TraceResponseV2[]` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.storeTracedWorkspace(submissionId, { ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.storeTracedWorkspace("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", { + workspaceRunDetails: { + exceptionV2: { + type: "generic", + }, + exception: {}, + stdout: "string", + }, + traceResponses: [ + { + submissionId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + lineNumber: 1, + returnValue: { + type: "integerValue", + value: 1, + }, + expressionLocation: {}, + stack: {}, + stdout: "string", + }, + ], +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.StoreTracedWorkspaceRequest` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.admin.storeTracedWorkspaceV2(submissionId, { ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.admin.storeTracedWorkspaceV2("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", [ + { + submissionId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", + lineNumber: 1, + file: {}, + returnValue: { + type: "integerValue", + value: 1, + }, + expressionLocation: {}, + stack: {}, + stdout: "string", + }, +]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `SeedTrace.SubmissionId` + +
+
+ +
+
+ +**request:** `SeedTrace.TraceResponseV2[]` + +
+
+ +
+
+ +**requestOptions:** `Admin.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Homepage + +
client.homepage.getHomepageProblems() -> SeedTrace.ProblemId[] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.homepage.getHomepageProblems(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Homepage.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.homepage.setHomepageProblems({ ...params }) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.homepage.setHomepageProblems(["string"]); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedTrace.ProblemId[]` + +
+
+ +
+
+ +**requestOptions:** `Homepage.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Migration + +
client.migration.getAttemptedMigrations({ ...params }) -> SeedTrace.Migration[] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.migration.getAttemptedMigrations({ + "admin-key-header": "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedTrace.GetAttemptedMigrationsRequest` + +
+
+ +
+
+ +**requestOptions:** `Migration.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Playlist + +
client.playlist.createPlaylist(serviceParam, { ...params }) -> SeedTrace.Playlist +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Create a new playlist + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.playlist.createPlaylist(1, { + datetime: new Date("2024-01-15T09:30:00.000Z"), + optionalDatetime: new Date("2024-01-15T09:30:00.000Z"), + body: { + name: "string", + problems: ["string"], + }, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `number` + +
+
+ +
+
+ +**request:** `SeedTrace.CreatePlaylistRequest` + +
+
+ +
+
+ +**requestOptions:** `Playlist.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.playlist.getPlaylists(serviceParam, { ...params }) -> SeedTrace.Playlist[] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the user's playlists + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.playlist.getPlaylists(1, { + limit: 1, + otherField: "string", + multiLineDocs: "string", + optionalMultipleField: "string", + multipleField: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `number` + +
+
+ +
+
+ +**request:** `SeedTrace.GetPlaylistsRequest` + +
+
+ +
+
+ +**requestOptions:** `Playlist.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.playlist.getPlaylist(serviceParam, playlistId) -> SeedTrace.Playlist +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a playlist + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.playlist.getPlaylist(1, "string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `number` + +
+
+ +
+
+ +**playlistId:** `SeedTrace.PlaylistId` + +
+
+ +
+
+ +**requestOptions:** `Playlist.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.playlist.updatePlaylist(serviceParam, playlistId, { ...params }) -> SeedTrace.Playlist | undefined +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a playlist + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.playlist.updatePlaylist(1, "string", { + name: "string", + problems: ["string"], +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `number` + +
+
+ +
+
+ +**playlistId:** `SeedTrace.PlaylistId` + +
+
+ +
+
+ +**request:** `SeedTrace.UpdatePlaylistRequest` + +
+
+ +
+
+ +**requestOptions:** `Playlist.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.playlist.deletePlaylist(serviceParam, playlistId) -> void +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a playlist + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.playlist.deletePlaylist(1, "string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `number` + +
+
+ +
+
+ +**playlistId:** `SeedTrace.PlaylistId` + +
+
+ +
+
+ +**requestOptions:** `Playlist.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Problem + +
client.problem.createProblem({ ...params }) -> SeedTrace.CreateProblemResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.problem.createProblem({ + problemName: "string", + problemDescription: { + boards: [ + { + type: "html", + value: "string", + }, + ], + }, + files: { + [SeedTrace.Language.Java]: { + solutionFile: { + filename: "string", + contents: "string", + }, + readOnlyFiles: [ + { + filename: "string", + contents: "string", + }, + ], + }, + }, + inputParams: [ + { + variableType: { + type: "integerType", + }, + name: "string", + }, + ], + outputType: { + type: "integerType", + }, + testcases: [ + { + testCase: { + id: "string", + params: [ + { + type: "integerValue", + value: 1, + }, + ], + }, + expectedResult: { + type: "integerValue", + value: 1, + }, + }, + ], + methodName: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedTrace.CreateProblemRequest` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.problem.updateProblem(problemId, { ...params }) -> SeedTrace.UpdateProblemResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.problem.updateProblem("string", { + problemName: "string", + problemDescription: { + boards: [ + { + type: "html", + value: "string", + }, + ], + }, + files: { + [SeedTrace.Language.Java]: { + solutionFile: { + filename: "string", + contents: "string", + }, + readOnlyFiles: [ + { + filename: "string", + contents: "string", + }, + ], + }, + }, + inputParams: [ + { + variableType: { + type: "integerType", + }, + name: "string", + }, + ], + outputType: { + type: "integerType", + }, + testcases: [ + { + testCase: { + id: "string", + params: [ + { + type: "integerValue", + value: 1, + }, + ], + }, + expectedResult: { + type: "integerValue", + value: 1, + }, + }, + ], + methodName: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**request:** `SeedTrace.CreateProblemRequest` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.problem.deleteProblem(problemId) -> void +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Soft deletes a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.problem.deleteProblem("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.problem.getDefaultStarterFiles({ ...params }) -> SeedTrace.GetDefaultStarterFilesResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns default starter files for problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.problem.getDefaultStarterFiles({ + inputParams: [ + { + variableType: { + type: "integerType", + }, + name: "string", + }, + ], + outputType: { + type: "integerType", + }, + methodName: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedTrace.GetDefaultStarterFilesRequest` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Submission + +
client.submission.createExecutionSession(language) -> SeedTrace.ExecutionSessionResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns sessionId and execution server URL for session. Spins up server. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.submission.createExecutionSession(SeedTrace.Language.Java); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**language:** `SeedTrace.Language` + +
+
+ +
+
+ +**requestOptions:** `Submission.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.submission.getExecutionSession(sessionId) -> SeedTrace.ExecutionSessionResponse | undefined +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns execution server URL for session. Returns empty if session isn't registered. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.submission.getExecutionSession("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**sessionId:** `string` + +
+
+ +
+
+ +**requestOptions:** `Submission.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.submission.stopExecutionSession(sessionId) -> void +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Stops execution session. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.submission.stopExecutionSession("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**sessionId:** `string` + +
+
+ +
+
+ +**requestOptions:** `Submission.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.submission.getExecutionSessionsState() -> SeedTrace.GetExecutionSessionStateResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.submission.getExecutionSessionsState(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Submission.RequestOptions` + +
+
+
+
+ +
+
+
+ +## Sysprop + +
client.sysprop.setNumWarmInstances(language, numWarmInstances) -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.sysprop.setNumWarmInstances(SeedTrace.Language.Java, 1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**language:** `SeedTrace.Language` + +
+
+ +
+
+ +**numWarmInstances:** `number` + +
+
+ +
+
+ +**requestOptions:** `Sysprop.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.sysprop.getNumWarmInstances() -> Record +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.sysprop.getNumWarmInstances(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Sysprop.RequestOptions` + +
+
+
+
+ +
+
+
+ +## V2 Problem + +
client.v2.problem.getLightweightProblems() -> SeedTrace.LightweightProblemInfoV2[] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns lightweight versions of all problems + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.problem.getLightweightProblems(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.problem.getProblems() -> SeedTrace.ProblemInfoV2[] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns latest versions of all problems + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.problem.getProblems(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.problem.getLatestProblem(problemId) -> SeedTrace.ProblemInfoV2 +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns latest version of a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.problem.getLatestProblem("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.problem.getProblemVersion(problemId, problemVersion) -> SeedTrace.ProblemInfoV2 +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns requested version of a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.problem.getProblemVersion("string", 1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**problemVersion:** `number` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +## V2 V3 Problem + +
client.v2.v3.problem.getLightweightProblems() -> SeedTrace.LightweightProblemInfoV2[] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns lightweight versions of all problems + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.v3.problem.getLightweightProblems(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.v3.problem.getProblems() -> SeedTrace.ProblemInfoV2[] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns latest versions of all problems + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.v3.problem.getProblems(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.v3.problem.getLatestProblem(problemId) -> SeedTrace.ProblemInfoV2 +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns latest version of a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.v3.problem.getLatestProblem("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.v2.v3.problem.getProblemVersion(problemId, problemVersion) -> SeedTrace.ProblemInfoV2 +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns requested version of a problem + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.v2.v3.problem.getProblemVersion("string", 1); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `SeedTrace.ProblemId` + +
+
+ +
+
+ +**problemVersion:** `number` + +
+
+ +
+
+ +**requestOptions:** `Problem.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/undiscriminated-unions/no-custom-config/reference.md b/seed/ts-sdk/undiscriminated-unions/no-custom-config/reference.md new file mode 100644 index 00000000000..0305d918113 --- /dev/null +++ b/seed/ts-sdk/undiscriminated-unions/no-custom-config/reference.md @@ -0,0 +1,91 @@ +# Reference + +## Union + +
client.union.get({ ...params }) -> SeedUndiscriminatedUnions.MyUnion +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.union.get("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedUndiscriminatedUnions.MyUnion` + +
+
+ +
+
+ +**requestOptions:** `Union.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.union.getMetadata() -> SeedUndiscriminatedUnions.Metadata +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.union.getMetadata(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Union.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/undiscriminated-unions/skip-response-validation/reference.md b/seed/ts-sdk/undiscriminated-unions/skip-response-validation/reference.md new file mode 100644 index 00000000000..0305d918113 --- /dev/null +++ b/seed/ts-sdk/undiscriminated-unions/skip-response-validation/reference.md @@ -0,0 +1,91 @@ +# Reference + +## Union + +
client.union.get({ ...params }) -> SeedUndiscriminatedUnions.MyUnion +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.union.get("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedUndiscriminatedUnions.MyUnion` + +
+
+ +
+
+ +**requestOptions:** `Union.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.union.getMetadata() -> SeedUndiscriminatedUnions.Metadata +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.union.getMetadata(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Union.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/unions/reference.md b/seed/ts-sdk/unions/reference.md new file mode 100644 index 00000000000..92972d1e883 --- /dev/null +++ b/seed/ts-sdk/unions/reference.md @@ -0,0 +1,103 @@ +# Reference + +## Union + +
client.union.get(id) -> SeedUnions.Shape +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.union.get("string"); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `string` + +
+
+ +
+
+ +**requestOptions:** `Union.RequestOptions` + +
+
+
+
+ +
+
+
+ +
client.union.update({ ...params }) -> boolean +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.union.update({ + type: "circle", + id: "string", + radius: 1.1, +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedUnions.Shape` + +
+
+ +
+
+ +**requestOptions:** `Union.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/unknown/no-custom-config/reference.md b/seed/ts-sdk/unknown/no-custom-config/reference.md new file mode 100644 index 00000000000..c9f1646c21c --- /dev/null +++ b/seed/ts-sdk/unknown/no-custom-config/reference.md @@ -0,0 +1,53 @@ +# Reference + +## Unknown + +
client.unknown.post({ ...params }) -> unknown[] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.unknown.post({ + key: "value", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `unknown` + +
+
+ +
+
+ +**requestOptions:** `Unknown.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/unknown/unknown-as-any/reference.md b/seed/ts-sdk/unknown/unknown-as-any/reference.md new file mode 100644 index 00000000000..29f7d5685e5 --- /dev/null +++ b/seed/ts-sdk/unknown/unknown-as-any/reference.md @@ -0,0 +1,53 @@ +# Reference + +## Unknown + +
client.unknown.post({ ...params }) -> any[] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.unknown.post({ + key: "value", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `any` + +
+
+ +
+
+ +**requestOptions:** `Unknown.RequestOptions` + +
+
+
+
+ +
+
+
diff --git a/seed/ts-sdk/validation/reference.md b/seed/ts-sdk/validation/reference.md new file mode 100644 index 00000000000..c1a16477721 --- /dev/null +++ b/seed/ts-sdk/validation/reference.md @@ -0,0 +1,55 @@ +# Reference + +
client.get({ ...params }) -> SeedValidation.Type +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.get({ + decimal: 1.1, + even: 1, + name: "string", +}); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SeedValidation.GetRequest` + +
+
+ +
+
+ +**requestOptions:** `SeedValidationClient.RequestOptions` + +
+
+
+
+ +
+
+
+ +## diff --git a/seed/ts-sdk/variables/reference.md b/seed/ts-sdk/variables/reference.md new file mode 100644 index 00000000000..a3b7bd553a7 --- /dev/null +++ b/seed/ts-sdk/variables/reference.md @@ -0,0 +1,43 @@ +# Reference + +## Service + +
client.service.post() -> void +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.service.post(); +``` + +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requestOptions:** `Service.RequestOptions` + +
+
+
+
+ +
+
+