diff --git a/generators/ruby-v2/base/src/project/RubyProject.ts b/generators/ruby-v2/base/src/project/RubyProject.ts index 220bc7071bd..80b693c7f2f 100644 --- a/generators/ruby-v2/base/src/project/RubyProject.ts +++ b/generators/ruby-v2/base/src/project/RubyProject.ts @@ -398,7 +398,7 @@ class CustomTestFile { # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/generators/ruby-v2/sdk/src/SdkGeneratorCli.ts b/generators/ruby-v2/sdk/src/SdkGeneratorCli.ts index 838ed0ff635..73452228ff7 100644 --- a/generators/ruby-v2/sdk/src/SdkGeneratorCli.ts +++ b/generators/ruby-v2/sdk/src/SdkGeneratorCli.ts @@ -8,6 +8,7 @@ import { FernGeneratorExec } from "@fern-fern/generator-exec-sdk"; import { Endpoint } from "@fern-fern/generator-exec-sdk/api"; import { HttpService, IntermediateRepresentation } from "@fern-fern/ir-sdk/api"; import { SingleUrlEnvironmentGenerator } from "./environment/SingleUrlEnvironmentGenerator"; +import { buildReference } from "./reference/buildReference"; import { RootClientGenerator } from "./root-client/RootClientGenerator"; import { SdkCustomConfigSchema } from "./SdkCustomConfig"; import { SdkGeneratorContext } from "./SdkGeneratorContext"; @@ -112,6 +113,16 @@ export class SdkGeneratorCLI extends AbstractRubyGeneratorCli { + const builder = buildReference({ context }); + const content = await context.generatorAgent.generateReference(builder); + + context.project.addRawFiles( + new File(context.generatorAgent.REFERENCE_FILENAME, RelativeFilePath.of("."), content) + ); + } } diff --git a/generators/ruby-v2/sdk/src/SdkGeneratorContext.ts b/generators/ruby-v2/sdk/src/SdkGeneratorContext.ts index 64911270ece..45dd8d62306 100644 --- a/generators/ruby-v2/sdk/src/SdkGeneratorContext.ts +++ b/generators/ruby-v2/sdk/src/SdkGeneratorContext.ts @@ -1,14 +1,18 @@ import { GeneratorNotificationService } from "@fern-api/base-generator"; +import { assertNever } from "@fern-api/core-utils"; import { join, RelativeFilePath } from "@fern-api/path-utils"; import { ruby } from "@fern-api/ruby-ast"; import { ClassReference } from "@fern-api/ruby-ast/src/ast/ClassReference"; import { AbstractRubyGeneratorContext, AsIsFiles, RubyProject } from "@fern-api/ruby-base"; import { FernGeneratorExec } from "@fern-fern/generator-exec-sdk"; import { + ExampleEndpointCall, + HttpEndpoint, HttpService, IntermediateRepresentation, Name, ServiceId, + StreamingResponse, Subpackage, SubpackageId, TypeDeclaration, @@ -98,6 +102,82 @@ export class SdkGeneratorContext extends AbstractRubyGeneratorContext 0) { + const exampleEndpointCall = endpoint.userSpecifiedExamples[0]?.example; + if (exampleEndpointCall != null) { + return exampleEndpointCall; + } + } + // Fall back to auto-generated examples + const exampleEndpointCall = endpoint.autogeneratedExamples[0]?.example; + + return exampleEndpointCall ?? null; + } + + public getReturnTypeForEndpoint(httpEndpoint: HttpEndpoint): ruby.Type { + const responseBody = httpEndpoint.response?.body; + + if (responseBody == null) { + return ruby.Type.void(); + } + + switch (responseBody.type) { + case "json": + return this.typeMapper.convert({ reference: responseBody.value.responseBodyType }); + case "fileDownload": + case "text": + return ruby.Type.string(); + case "bytes": + throw new Error("Returning bytes is not supported"); + case "streaming": + case "streamParameter": { + const streamingResponse = this.getStreamingResponse(httpEndpoint); + if (!streamingResponse) { + throw new Error( + `Unable to parse streaming response for endpoint ${httpEndpoint.name.camelCase.safeName}` + ); + } + return this.getStreamPayload(streamingResponse); + } + default: + assertNever(responseBody); + } + } + + public getStreamingResponse(endpoint: HttpEndpoint): StreamingResponse | undefined { + const responseBody = endpoint.response?.body; + if (responseBody == null) { + return undefined; + } + switch (responseBody.type) { + case "streaming": + return responseBody.value; + case "streamParameter": + return responseBody.streamResponse; + case "fileDownload": + case "json": + case "text": + case "bytes": + return undefined; + default: + assertNever(responseBody); + } + } + + public getStreamPayload(streamingResponse: StreamingResponse): ruby.Type { + switch (streamingResponse.type) { + case "json": + case "sse": + return this.typeMapper.convert({ reference: streamingResponse.payload }); + case "text": + return ruby.Type.string(); + default: + assertNever(streamingResponse); + } + } + public getSubpackageOrThrow(subpackageId: SubpackageId): Subpackage { const subpackage = this.ir.subpackages[subpackageId]; if (subpackage == null) { diff --git a/generators/ruby-v2/sdk/src/reference/buildReference.ts b/generators/ruby-v2/sdk/src/reference/buildReference.ts new file mode 100644 index 00000000000..4e80aea5e45 --- /dev/null +++ b/generators/ruby-v2/sdk/src/reference/buildReference.ts @@ -0,0 +1,238 @@ +import { ReferenceConfigBuilder } from "@fern-api/base-generator"; +import { ruby } from "@fern-api/ruby-ast"; + +import { FernGeneratorCli } from "@fern-fern/generator-cli-sdk"; +import { HttpEndpoint, HttpService, ServiceId, TypeReference } from "@fern-fern/ir-sdk/api"; + +import { SdkGeneratorContext } from "../SdkGeneratorContext"; +import { SingleEndpointSnippet } from "./EndpointSnippetsGenerator"; + +export function buildReference({ context }: { context: SdkGeneratorContext }): ReferenceConfigBuilder { + const builder = new ReferenceConfigBuilder(); + const serviceEntries = Object.entries(context.ir.services); + + serviceEntries.forEach(([serviceId, service]) => { + const section = isRootServiceId({ context, serviceId }) + ? builder.addRootSection() + : builder.addSection({ title: getSectionTitle({ service }) }); + const endpoints = getEndpointReferencesForService({ context, serviceId, service }); + for (const endpoint of endpoints) { + section.addEndpoint(endpoint); + } + }); + + return builder; +} + +function getEndpointReferencesForService({ + context, + serviceId, + service +}: { + context: SdkGeneratorContext; + serviceId: ServiceId; + service: HttpService; +}): FernGeneratorCli.EndpointReference[] { + return service.endpoints + .map((endpoint) => { + let singleEndpointSnippet; + const exampleCall = context.maybeGetExampleEndpointCall(endpoint); + if (exampleCall) { + singleEndpointSnippet = context.snippetGenerator.getSingleEndpointSnippet({ + endpoint, + example: exampleCall + }); + } + if (!singleEndpointSnippet) { + return undefined; + } + return getEndpointReference({ + context, + serviceId, + service, + endpoint, + singleEndpointSnippet + }); + }) + .filter((endpoint): endpoint is FernGeneratorCli.EndpointReference => !!endpoint); +} + +function getEndpointReference({ + context, + serviceId, + service, + endpoint, + singleEndpointSnippet +}: { + context: SdkGeneratorContext; + serviceId: ServiceId; + service: HttpService; + endpoint: HttpEndpoint; + singleEndpointSnippet: SingleEndpointSnippet; +}): FernGeneratorCli.EndpointReference { + const returnValue = getReturnValue({ context, endpoint }); + return { + title: { + snippetParts: [ + { + text: getAccessFromRootClient({ context, service }) + "." + }, + { + text: getEndpointMethodName({ endpoint }) + }, + { + text: getReferenceEndpointInvocationParameters({ context, endpoint }) + } + ], + returnValue + }, + description: endpoint.docs, + snippet: singleEndpointSnippet.endpointCall.trim(), + parameters: getEndpointParameters({ context, endpoint }) + }; +} + +function getAccessFromRootClient({ context, service }: { context: SdkGeneratorContext; service: HttpService }): string { + const clientVariableName = "client"; + const servicePath = service.name.fernFilepath.allParts.map((part) => part.pascalCase.safeName); + return servicePath.length > 0 ? `${clientVariableName}.${servicePath.join(".")}` : clientVariableName; +} + +function getEndpointMethodName({ endpoint }: { endpoint: HttpEndpoint }): string { + return endpoint.name.pascalCase.safeName; +} + +function getReferenceEndpointInvocationParameters({ + context, + endpoint +}: { + context: SdkGeneratorContext; + endpoint: HttpEndpoint; +}): string { + const parameters: string[] = []; + + endpoint.allPathParameters.forEach((pathParam) => { + parameters.push(pathParam.name.pascalCase.safeName); + }); + + if (endpoint.requestBody != null) { + switch (endpoint.requestBody.type) { + case "inlinedRequestBody": + parameters.push("request"); + break; + case "reference": + parameters.push("request"); + break; + case "fileUpload": + parameters.push("request"); + break; + case "bytes": + parameters.push("request"); + break; + } + } + + return `(${parameters.join(", ")})`; +} + +function getReturnValue({ + context, + endpoint +}: { + context: SdkGeneratorContext; + endpoint: HttpEndpoint; +}): { text: string } | undefined { + const returnType = context.getReturnTypeForEndpoint(endpoint); + const returnTypeString = getSimpleTypeName(returnType, context); + return { text: returnTypeString }; +} + +function getRubyTypeString({ + context, + typeReference +}: { + context: SdkGeneratorContext; + typeReference: TypeReference; +}): string { + const rubyType = context.typeMapper.convert({ reference: typeReference }); + return getSimpleTypeName(rubyType, context); +} + +function getSimpleTypeName(rubyType: ruby.Type, context: SdkGeneratorContext): string { + const simpleWriter = new ruby.Writer({ + customConfig: context.customConfig + }); + + rubyType.write(simpleWriter); + + const typeName = simpleWriter.buffer.trim(); + + // TODO: anything else?? + + return typeName; +} + +function getEndpointParameters({ + context, + endpoint +}: { + context: SdkGeneratorContext; + endpoint: HttpEndpoint; +}): FernGeneratorCli.ParameterReference[] { + const parameters: FernGeneratorCli.ParameterReference[] = []; + + endpoint.allPathParameters.forEach((pathParam) => { + parameters.push({ + name: pathParam.name.camelCase.safeName, + type: getRubyTypeString({ context, typeReference: pathParam.valueType }), + description: pathParam.docs, + required: true + }); + }); + + endpoint.queryParameters.forEach((queryParam) => { + parameters.push({ + name: queryParam.name.name.camelCase.safeName, + type: getRubyTypeString({ context, typeReference: queryParam.valueType }), + description: queryParam.docs, + required: !queryParam.allowMultiple + }); + }); + + endpoint.headers.forEach((header) => { + parameters.push({ + name: header.name.name.camelCase.safeName, + type: getRubyTypeString({ context, typeReference: header.valueType }), + description: header.docs, + required: true + }); + }); + + if (endpoint.requestBody != null && endpoint.requestBody.type === "inlinedRequestBody") { + endpoint.requestBody.properties.forEach((property) => { + parameters.push({ + name: property.name.name.camelCase.safeName, + type: getRubyTypeString({ context, typeReference: property.valueType }), + description: property.docs, + required: true + }); + }); + } else if (endpoint.requestBody != null && endpoint.requestBody.type === "reference") { + parameters.push({ + name: "request", + type: getRubyTypeString({ context, typeReference: endpoint.requestBody.requestBodyType }), + description: endpoint.requestBody.docs, + required: true + }); + } + + return parameters; +} + +function isRootServiceId({ context, serviceId }: { context: SdkGeneratorContext; serviceId: ServiceId }): boolean { + return context.ir.rootPackage.service === serviceId; +} + +function getSectionTitle({ service }: { service: HttpService }): string { + return service.displayName ?? service.name.fernFilepath.allParts.map((part) => part.pascalCase.safeName).join(" "); +} diff --git a/seed/ruby-sdk-v2/accept-header/reference.md b/seed/ruby-sdk-v2/accept-header/reference.md new file mode 100644 index 00000000000..fe20a5ca2bc --- /dev/null +++ b/seed/ruby-sdk-v2/accept-header/reference.md @@ -0,0 +1,26 @@ +# Reference +## Service +
client.Service.Endpoint() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.endpoint(); +``` +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/accept-header/test/custom.test.rb b/seed/ruby-sdk-v2/accept-header/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/accept-header/test/custom.test.rb +++ b/seed/ruby-sdk-v2/accept-header/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/alias-extends/reference.md b/seed/ruby-sdk-v2/alias-extends/reference.md new file mode 100644 index 00000000000..388bf68f930 --- /dev/null +++ b/seed/ruby-sdk-v2/alias-extends/reference.md @@ -0,0 +1,43 @@ +# Reference +
client.ExtendedInlineRequestBody(request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.extended_inline_request_body({ + parent:'parent', + child:'child' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**child:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/alias-extends/test/custom.test.rb b/seed/ruby-sdk-v2/alias-extends/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/alias-extends/test/custom.test.rb +++ b/seed/ruby-sdk-v2/alias-extends/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/alias/reference.md b/seed/ruby-sdk-v2/alias/reference.md new file mode 100644 index 00000000000..7e0c98ed862 --- /dev/null +++ b/seed/ruby-sdk-v2/alias/reference.md @@ -0,0 +1,40 @@ +# Reference +
client.Get(TypeId) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.get(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**typeId:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/alias/test/custom.test.rb b/seed/ruby-sdk-v2/alias/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/alias/test/custom.test.rb +++ b/seed/ruby-sdk-v2/alias/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/any-auth/reference.md b/seed/ruby-sdk-v2/any-auth/reference.md new file mode 100644 index 00000000000..3844739d399 --- /dev/null +++ b/seed/ruby-sdk-v2/any-auth/reference.md @@ -0,0 +1,130 @@ +# Reference +## Auth +
client.Auth.GetToken(request) -> Seed::Auth::Types::TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.auth.get_token({ + clientId:'client_id', + clientSecret:'client_secret', + audience:'https://api.example.com', + grantType:'client_credentials', + scope:'scope' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**clientId:** `String` + +
+
+ +
+
+ +**clientSecret:** `String` + +
+
+ +
+
+ +**audience:** `String` + +
+
+ +
+
+ +**grantType:** `String` + +
+
+ +
+
+ +**scope:** `String` + +
+
+
+
+ + +
+
+
+ +## User +
client.User.Get() -> Internal::Types::Array[Seed::User::Types::User] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.user.get(); +``` +
+
+
+
+ + +
+
+
+ +
client.User.GetAdmins() -> Internal::Types::Array[Seed::User::Types::User] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.user.get_admins(); +``` +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/any-auth/test/custom.test.rb b/seed/ruby-sdk-v2/any-auth/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/any-auth/test/custom.test.rb +++ b/seed/ruby-sdk-v2/any-auth/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/api-wide-base-path/reference.md b/seed/ruby-sdk-v2/api-wide-base-path/reference.md new file mode 100644 index 00000000000..990767bc097 --- /dev/null +++ b/seed/ruby-sdk-v2/api-wide-base-path/reference.md @@ -0,0 +1,65 @@ +# Reference +## Service +
client.Service.Post(PathParam, ServiceParam, ResourceParam, EndpointParam) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.post(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**pathParam:** `String` + +
+
+ +
+
+ +**serviceParam:** `String` + +
+
+ +
+
+ +**resourceParam:** `String` + +
+
+ +
+
+ +**endpointParam:** `Integer` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/api-wide-base-path/test/custom.test.rb b/seed/ruby-sdk-v2/api-wide-base-path/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/api-wide-base-path/test/custom.test.rb +++ b/seed/ruby-sdk-v2/api-wide-base-path/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/audiences/reference.md b/seed/ruby-sdk-v2/audiences/reference.md new file mode 100644 index 00000000000..1084c837576 --- /dev/null +++ b/seed/ruby-sdk-v2/audiences/reference.md @@ -0,0 +1,113 @@ +# Reference +## FolderA Service +
client.FolderA.Service.GetDirectThread() -> Seed::FolderA::Service::Types::Response +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.folder_a.service.get_direct_thread(); +``` +
+
+
+
+ + +
+
+
+ +## FolderD Service +
client.FolderD.Service.GetDirectThread() -> Seed::FolderD::Service::Types::Response +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.folder_d.service.get_direct_thread(); +``` +
+
+
+
+ + +
+
+
+ +## Foo +
client.Foo.Find(request) -> Seed::Foo::Types::ImportingType +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.foo.find({ + optionalString:'optionalString', + publicProperty:'publicProperty', + privateProperty:1 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**optionalString:** `String` + +
+
+ +
+
+ +**publicProperty:** `String` + +
+
+ +
+
+ +**privateProperty:** `Integer` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/audiences/test/custom.test.rb b/seed/ruby-sdk-v2/audiences/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/audiences/test/custom.test.rb +++ b/seed/ruby-sdk-v2/audiences/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/auth-environment-variables/reference.md b/seed/ruby-sdk-v2/auth-environment-variables/reference.md new file mode 100644 index 00000000000..5e45be0b1d1 --- /dev/null +++ b/seed/ruby-sdk-v2/auth-environment-variables/reference.md @@ -0,0 +1,96 @@ +# Reference +## Service +
client.Service.GetWithApiKey() -> String +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET request with custom api key +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get_with_api_key(); +``` +
+
+
+
+ + +
+
+
+ +
client.Service.GetWithHeader() -> String +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET request with custom api key +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get_with_header({ + xEndpointHeader:'X-Endpoint-Header' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**xEndpointHeader:** `String` — Specifies the endpoint key. + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/auth-environment-variables/test/custom.test.rb b/seed/ruby-sdk-v2/auth-environment-variables/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/auth-environment-variables/test/custom.test.rb +++ b/seed/ruby-sdk-v2/auth-environment-variables/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/basic-auth-environment-variables/reference.md b/seed/ruby-sdk-v2/basic-auth-environment-variables/reference.md new file mode 100644 index 00000000000..be8d987591a --- /dev/null +++ b/seed/ruby-sdk-v2/basic-auth-environment-variables/reference.md @@ -0,0 +1,94 @@ +# Reference +## BasicAuth +
client.BasicAuth.GetWithBasicAuth() -> Internal::Types::Boolean +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET request with basic auth scheme +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.basic_auth.get_with_basic_auth(); +``` +
+
+
+
+ + +
+
+
+ +
client.BasicAuth.PostWithBasicAuth(request) -> Internal::Types::Boolean +
+
+ +#### 📝 Description + +
+
+ +
+
+ +POST request with basic auth scheme +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.basic_auth.post_with_basic_auth(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Internal::Types::Hash[String, Object]` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/basic-auth-environment-variables/test/custom.test.rb b/seed/ruby-sdk-v2/basic-auth-environment-variables/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/basic-auth-environment-variables/test/custom.test.rb +++ b/seed/ruby-sdk-v2/basic-auth-environment-variables/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/basic-auth/reference.md b/seed/ruby-sdk-v2/basic-auth/reference.md new file mode 100644 index 00000000000..be8d987591a --- /dev/null +++ b/seed/ruby-sdk-v2/basic-auth/reference.md @@ -0,0 +1,94 @@ +# Reference +## BasicAuth +
client.BasicAuth.GetWithBasicAuth() -> Internal::Types::Boolean +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET request with basic auth scheme +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.basic_auth.get_with_basic_auth(); +``` +
+
+
+
+ + +
+
+
+ +
client.BasicAuth.PostWithBasicAuth(request) -> Internal::Types::Boolean +
+
+ +#### 📝 Description + +
+
+ +
+
+ +POST request with basic auth scheme +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.basic_auth.post_with_basic_auth(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Internal::Types::Hash[String, Object]` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/basic-auth/test/custom.test.rb b/seed/ruby-sdk-v2/basic-auth/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/basic-auth/test/custom.test.rb +++ b/seed/ruby-sdk-v2/basic-auth/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/bearer-token-environment-variable/reference.md b/seed/ruby-sdk-v2/bearer-token-environment-variable/reference.md new file mode 100644 index 00000000000..c0104bd8b33 --- /dev/null +++ b/seed/ruby-sdk-v2/bearer-token-environment-variable/reference.md @@ -0,0 +1,40 @@ +# Reference +## Service +
client.Service.GetWithBearerToken() -> String +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET request with custom api key +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get_with_bearer_token(); +``` +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/bearer-token-environment-variable/test/custom.test.rb b/seed/ruby-sdk-v2/bearer-token-environment-variable/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/bearer-token-environment-variable/test/custom.test.rb +++ b/seed/ruby-sdk-v2/bearer-token-environment-variable/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/bytes-download/reference.md b/seed/ruby-sdk-v2/bytes-download/reference.md new file mode 100644 index 00000000000..aecd4cd2bbc --- /dev/null +++ b/seed/ruby-sdk-v2/bytes-download/reference.md @@ -0,0 +1,2 @@ +# Reference +## Service \ No newline at end of file diff --git a/seed/ruby-sdk-v2/bytes-download/test/custom.test.rb b/seed/ruby-sdk-v2/bytes-download/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/bytes-download/test/custom.test.rb +++ b/seed/ruby-sdk-v2/bytes-download/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/bytes-upload/reference.md b/seed/ruby-sdk-v2/bytes-upload/reference.md new file mode 100644 index 00000000000..dc19e3f5c49 --- /dev/null +++ b/seed/ruby-sdk-v2/bytes-upload/reference.md @@ -0,0 +1,26 @@ +# Reference +## Service +
client.Service.Upload(request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.upload(); +``` +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/bytes-upload/test/custom.test.rb b/seed/ruby-sdk-v2/bytes-upload/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/bytes-upload/test/custom.test.rb +++ b/seed/ruby-sdk-v2/bytes-upload/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/circular-references-advanced/reference.md b/seed/ruby-sdk-v2/circular-references-advanced/reference.md new file mode 100644 index 00000000000..4a938e09d06 --- /dev/null +++ b/seed/ruby-sdk-v2/circular-references-advanced/reference.md @@ -0,0 +1 @@ +# Reference \ No newline at end of file diff --git a/seed/ruby-sdk-v2/circular-references-advanced/test/custom.test.rb b/seed/ruby-sdk-v2/circular-references-advanced/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/circular-references-advanced/test/custom.test.rb +++ b/seed/ruby-sdk-v2/circular-references-advanced/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/circular-references/reference.md b/seed/ruby-sdk-v2/circular-references/reference.md new file mode 100644 index 00000000000..4a938e09d06 --- /dev/null +++ b/seed/ruby-sdk-v2/circular-references/reference.md @@ -0,0 +1 @@ +# Reference \ No newline at end of file diff --git a/seed/ruby-sdk-v2/circular-references/test/custom.test.rb b/seed/ruby-sdk-v2/circular-references/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/circular-references/test/custom.test.rb +++ b/seed/ruby-sdk-v2/circular-references/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/client-side-params/reference.md b/seed/ruby-sdk-v2/client-side-params/reference.md new file mode 100644 index 00000000000..e830c1d1be5 --- /dev/null +++ b/seed/ruby-sdk-v2/client-side-params/reference.md @@ -0,0 +1,983 @@ +# Reference +## Service +
client.Service.ListResources() -> Internal::Types::Array[Seed::Types::Types::Resource] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +List resources with pagination +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.list_resources({ + page:1, + perPage:1, + sort:'created_at', + order:'desc', + includeTotals:true, + fields:'fields', + search:'search' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page:** `Integer` — Zero-indexed page number + +
+
+ +
+
+ +**perPage:** `Integer` — Number of items per page + +
+
+ +
+
+ +**sort:** `String` — Sort field + +
+
+ +
+
+ +**order:** `String` — Sort order (asc or desc) + +
+
+ +
+
+ +**includeTotals:** `Internal::Types::Boolean` — Whether to include total count + +
+
+ +
+
+ +**fields:** `String` — Comma-separated list of fields to include + +
+
+ +
+
+ +**search:** `String` — Search query + +
+
+
+
+ + +
+
+
+ +
client.Service.GetResource(ResourceId) -> Seed::Types::Types::Resource +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Get a single resource +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get_resource({ + resourceId:'resourceId', + includeMetadata:true, + format:'json' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**resourceId:** `String` + +
+
+ +
+
+ +**includeMetadata:** `Internal::Types::Boolean` — Include metadata in response + +
+
+ +
+
+ +**format:** `String` — Response format + +
+
+
+
+ + +
+
+
+ +
client.Service.SearchResources(request) -> Seed::Types::Types::SearchResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Search resources with complex parameters +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.search_resources({ + limit:1, + offset:1, + query:'query', + filters:{} +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**limit:** `Integer` — Maximum results to return + +
+
+ +
+
+ +**offset:** `Integer` — Offset for pagination + +
+
+ +
+
+ +**query:** `String` — Search query text + +
+
+ +
+
+ +**filters:** `Internal::Types::Hash[String, Internal::Types::Hash[String, Object]]` + +
+
+
+
+ + +
+
+
+ +
client.Service.ListUsers() -> Seed::Types::Types::PaginatedUserResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +List or search for users +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.list_users({ + page:1, + perPage:1, + includeTotals:true, + sort:'sort', + connection:'connection', + q:'q', + searchEngine:'search_engine', + fields:'fields' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page:** `Integer` — Page index of the results to return. First page is 0. + +
+
+ +
+
+ +**perPage:** `Integer` — Number of results per page. + +
+
+ +
+
+ +**includeTotals:** `Internal::Types::Boolean` — Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). + +
+
+ +
+
+ +**sort:** `String` — Field to sort by. Use field:order where order is 1 for ascending and -1 for descending. + +
+
+ +
+
+ +**connection:** `String` — Connection filter + +
+
+ +
+
+ +**q:** `String` — Query string following Lucene query string syntax + +
+
+ +
+
+ +**searchEngine:** `String` — Search engine version (v1, v2, or v3) + +
+
+ +
+
+ +**fields:** `String` — Comma-separated list of fields to include or exclude + +
+
+
+
+ + +
+
+
+ +
client.Service.GetUserById(UserId) -> Seed::Types::Types::User +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Get a user by ID +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get_user_by_id({ + userId:'userId', + fields:'fields', + includeFields:true +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**userId:** `String` + +
+
+ +
+
+ +**fields:** `String` — Comma-separated list of fields to include or exclude + +
+
+ +
+
+ +**includeFields:** `Internal::Types::Boolean` — true to include the fields specified, false to exclude them + +
+
+
+
+ + +
+
+
+ +
client.Service.CreateUser(request) -> Seed::Types::Types::User +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Create a new user +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.create_user({ + email:'email', + email_verified:true, + username:'username', + password:'password', + phone_number:'phone_number', + phone_verified:true, + user_metadata:{}, + app_metadata:{}, + connection:'connection' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Types::CreateUserRequest` + +
+
+
+
+ + +
+
+
+ +
client.Service.UpdateUser(UserId, request) -> Seed::Types::Types::User +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Update a user +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.update_user({ + email:'email', + email_verified:true, + username:'username', + phone_number:'phone_number', + phone_verified:true, + user_metadata:{}, + app_metadata:{}, + password:'password', + blocked:true +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**userId:** `String` + +
+
+ +
+
+ +**request:** `Seed::Types::Types::UpdateUserRequest` + +
+
+
+
+ + +
+
+
+ +
client.Service.DeleteUser(UserId) -> +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Delete a user +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.delete_user(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**userId:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Service.ListConnections() -> Internal::Types::Array[Seed::Types::Types::Connection] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +List all connections +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.list_connections({ + strategy:'strategy', + name:'name', + fields:'fields' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**strategy:** `String` — Filter by strategy type (e.g., auth0, google-oauth2, samlp) + +
+
+ +
+
+ +**name:** `String` — Filter by connection name + +
+
+ +
+
+ +**fields:** `String` — Comma-separated list of fields to include + +
+
+
+
+ + +
+
+
+ +
client.Service.GetConnection(ConnectionId) -> Seed::Types::Types::Connection +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Get a connection by ID +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get_connection({ + connectionId:'connectionId', + fields:'fields' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**connectionId:** `String` + +
+
+ +
+
+ +**fields:** `String` — Comma-separated list of fields to include + +
+
+
+
+ + +
+
+
+ +
client.Service.ListClients() -> Seed::Types::Types::PaginatedClientResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +List all clients/applications +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.list_clients({ + fields:'fields', + includeFields:true, + page:1, + perPage:1, + includeTotals:true, + isGlobal:true, + isFirstParty:true, + appType:['app_type', 'app_type'] +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**fields:** `String` — Comma-separated list of fields to include + +
+
+ +
+
+ +**includeFields:** `Internal::Types::Boolean` — Whether specified fields are included or excluded + +
+
+ +
+
+ +**page:** `Integer` — Page number (zero-based) + +
+
+ +
+
+ +**perPage:** `Integer` — Number of results per page + +
+
+ +
+
+ +**includeTotals:** `Internal::Types::Boolean` — Include total count in response + +
+
+ +
+
+ +**isGlobal:** `Internal::Types::Boolean` — Filter by global clients + +
+
+ +
+
+ +**isFirstParty:** `Internal::Types::Boolean` — Filter by first party clients + +
+
+ +
+
+ +**appType:** `Internal::Types::Array[String]` — Filter by application type (spa, native, regular_web, non_interactive) + +
+
+
+
+ + +
+
+
+ +
client.Service.GetClient(ClientId) -> Seed::Types::Types::Client +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Get a client by ID +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get_client({ + clientId:'clientId', + fields:'fields', + includeFields:true +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**clientId:** `String` + +
+
+ +
+
+ +**fields:** `String` — Comma-separated list of fields to include + +
+
+ +
+
+ +**includeFields:** `Internal::Types::Boolean` — Whether specified fields are included or excluded + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/client-side-params/test/custom.test.rb b/seed/ruby-sdk-v2/client-side-params/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/client-side-params/test/custom.test.rb +++ b/seed/ruby-sdk-v2/client-side-params/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/content-type/reference.md b/seed/ruby-sdk-v2/content-type/reference.md new file mode 100644 index 00000000000..d587d97f06d --- /dev/null +++ b/seed/ruby-sdk-v2/content-type/reference.md @@ -0,0 +1,454 @@ +# Reference +## Service +
client.Service.Patch(request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.patch({ + application:'application', + requireAuth:true +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**application:** `String` + +
+
+ +
+
+ +**requireAuth:** `Internal::Types::Boolean` + +
+
+
+
+ + +
+
+
+ +
client.Service.PatchComplex(Id, request) -> +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Update with JSON merge patch - complex types. +This endpoint demonstrates the distinction between: +- optional fields (can be present or absent, but not null) +- optional> fields (can be present, absent, or null) +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.patch_complex({ + id:'id', + name:'name', + age:1, + active:true, + metadata:{}, + tags:['tags', 'tags'], + email:'email', + nickname:'nickname', + bio:'bio', + profileImageUrl:'profileImageUrl', + settings:{} +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` + +
+
+ +
+
+ +**name:** `String` + +
+
+ +
+
+ +**age:** `Integer` + +
+
+ +
+
+ +**active:** `Internal::Types::Boolean` + +
+
+ +
+
+ +**metadata:** `Internal::Types::Hash[String, Internal::Types::Hash[String, Object]]` + +
+
+ +
+
+ +**tags:** `Internal::Types::Array[String]` + +
+
+ +
+
+ +**email:** `String` + +
+
+ +
+
+ +**nickname:** `String` + +
+
+ +
+
+ +**bio:** `String` + +
+
+ +
+
+ +**profileImageUrl:** `String` + +
+
+ +
+
+ +**settings:** `Internal::Types::Hash[String, Internal::Types::Hash[String, Object]]` + +
+
+
+
+ + +
+
+
+ +
client.Service.NamedPatchWithMixed(Id, request) -> +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Named request with mixed optional/nullable fields and merge-patch content type. +This should trigger the NPE issue when optional fields aren't initialized. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.named_patch_with_mixed({ + id:'id', + appId:'appId', + instructions:'instructions', + active:true +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` + +
+
+ +
+
+ +**appId:** `String` + +
+
+ +
+
+ +**instructions:** `String` + +
+
+ +
+
+ +**active:** `Internal::Types::Boolean` + +
+
+
+
+ + +
+
+
+ +
client.Service.OptionalMergePatchTest(request) -> +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Test endpoint to verify Optional field initialization and JsonSetter with Nulls.SKIP. +This endpoint should: +1. Not NPE when fields are not provided (tests initialization) +2. Not NPE when fields are explicitly null in JSON (tests Nulls.SKIP) +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.optional_merge_patch_test({ + requiredField:'requiredField', + optionalString:'optionalString', + optionalInteger:1, + optionalBoolean:true, + nullableString:'nullableString' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**requiredField:** `String` + +
+
+ +
+
+ +**optionalString:** `String` + +
+
+ +
+
+ +**optionalInteger:** `Integer` + +
+
+ +
+
+ +**optionalBoolean:** `Internal::Types::Boolean` + +
+
+ +
+
+ +**nullableString:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Service.RegularPatch(Id, request) -> +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Regular PATCH endpoint without merge-patch semantics +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.regular_patch({ + id:'id', + field1:'field1', + field2:1 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` + +
+
+ +
+
+ +**field1:** `String` + +
+
+ +
+
+ +**field2:** `Integer` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/content-type/test/custom.test.rb b/seed/ruby-sdk-v2/content-type/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/content-type/test/custom.test.rb +++ b/seed/ruby-sdk-v2/content-type/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/cross-package-type-names/reference.md b/seed/ruby-sdk-v2/cross-package-type-names/reference.md new file mode 100644 index 00000000000..077d2069c32 --- /dev/null +++ b/seed/ruby-sdk-v2/cross-package-type-names/reference.md @@ -0,0 +1,113 @@ +# Reference +## FolderA Service +
client.FolderA.Service.GetDirectThread() -> Seed::FolderA::Service::Types::Response +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.folder_a.service.get_direct_thread(); +``` +
+
+
+
+ + +
+
+
+ +## FolderD Service +
client.FolderD.Service.GetDirectThread() -> Seed::FolderD::Service::Types::Response +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.folder_a.service.get_direct_thread(); +``` +
+
+
+
+ + +
+
+
+ +## Foo +
client.Foo.Find(request) -> Seed::Foo::Types::ImportingType +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.foo.find({ + optionalString:'optionalString', + publicProperty:'publicProperty', + privateProperty:1 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**optionalString:** `String` + +
+
+ +
+
+ +**publicProperty:** `String` + +
+
+ +
+
+ +**privateProperty:** `Integer` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/cross-package-type-names/test/custom.test.rb b/seed/ruby-sdk-v2/cross-package-type-names/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/cross-package-type-names/test/custom.test.rb +++ b/seed/ruby-sdk-v2/cross-package-type-names/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/custom-auth/reference.md b/seed/ruby-sdk-v2/custom-auth/reference.md new file mode 100644 index 00000000000..4e0bece90f2 --- /dev/null +++ b/seed/ruby-sdk-v2/custom-auth/reference.md @@ -0,0 +1,94 @@ +# Reference +## CustomAuth +
client.CustomAuth.GetWithCustomAuth() -> Internal::Types::Boolean +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET request with custom auth scheme +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.custom_auth.get_with_custom_auth(); +``` +
+
+
+
+ + +
+
+
+ +
client.CustomAuth.PostWithCustomAuth(request) -> Internal::Types::Boolean +
+
+ +#### 📝 Description + +
+
+ +
+
+ +POST request with custom auth scheme +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.custom_auth.post_with_custom_auth(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Internal::Types::Hash[String, Object]` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/custom-auth/test/custom.test.rb b/seed/ruby-sdk-v2/custom-auth/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/custom-auth/test/custom.test.rb +++ b/seed/ruby-sdk-v2/custom-auth/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/empty-clients/reference.md b/seed/ruby-sdk-v2/empty-clients/reference.md new file mode 100644 index 00000000000..4a938e09d06 --- /dev/null +++ b/seed/ruby-sdk-v2/empty-clients/reference.md @@ -0,0 +1 @@ +# Reference \ No newline at end of file diff --git a/seed/ruby-sdk-v2/empty-clients/test/custom.test.rb b/seed/ruby-sdk-v2/empty-clients/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/empty-clients/test/custom.test.rb +++ b/seed/ruby-sdk-v2/empty-clients/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/enum/reference.md b/seed/ruby-sdk-v2/enum/reference.md new file mode 100644 index 00000000000..98fb784fad1 --- /dev/null +++ b/seed/ruby-sdk-v2/enum/reference.md @@ -0,0 +1,308 @@ +# Reference +## Headers +
client.Headers.Send() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.headers.send_({}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**operand:** `Seed::Types::Operand` + +
+
+ +
+
+ +**maybeOperand:** `Seed::Types::Operand` + +
+
+ +
+
+ +**operandOrColor:** `Seed::Types::ColorOrOperand` + +
+
+ +
+
+ +**maybeOperandOrColor:** `Seed::Types::ColorOrOperand` + +
+
+
+
+ + +
+
+
+ +## InlinedRequest +
client.InlinedRequest.Send(request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.inlined_request.send_({}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**operand:** `Seed::Types::Operand` + +
+
+ +
+
+ +**maybeOperand:** `Seed::Types::Operand` + +
+
+ +
+
+ +**operandOrColor:** `Seed::Types::ColorOrOperand` + +
+
+ +
+
+ +**maybeOperandOrColor:** `Seed::Types::ColorOrOperand` + +
+
+
+
+ + +
+
+
+ +## PathParam +
client.PathParam.Send(Operand, OperandOrColor) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.path_param.send_(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**operand:** `Seed::Types::Operand` + +
+
+ +
+
+ +**operandOrColor:** `Seed::Types::ColorOrOperand` + +
+
+
+
+ + +
+
+
+ +## QueryParam +
client.QueryParam.Send() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.query_param.send_({}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**operand:** `Seed::Types::Operand` + +
+
+ +
+
+ +**maybeOperand:** `Seed::Types::Operand` + +
+
+ +
+
+ +**operandOrColor:** `Seed::Types::ColorOrOperand` + +
+
+ +
+
+ +**maybeOperandOrColor:** `Seed::Types::ColorOrOperand` + +
+
+
+
+ + +
+
+
+ +
client.QueryParam.SendList() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.query_param.send_list({}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**operand:** `Seed::Types::Operand` + +
+
+ +
+
+ +**maybeOperand:** `Seed::Types::Operand` + +
+
+ +
+
+ +**operandOrColor:** `Seed::Types::ColorOrOperand` + +
+
+ +
+
+ +**maybeOperandOrColor:** `Seed::Types::ColorOrOperand` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/enum/test/custom.test.rb b/seed/ruby-sdk-v2/enum/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/enum/test/custom.test.rb +++ b/seed/ruby-sdk-v2/enum/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/error-property/reference.md b/seed/ruby-sdk-v2/error-property/reference.md new file mode 100644 index 00000000000..08f2afd343b --- /dev/null +++ b/seed/ruby-sdk-v2/error-property/reference.md @@ -0,0 +1,40 @@ +# Reference +## PropertyBasedError +
client.PropertyBasedError.ThrowError() -> String +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET request that always throws an error +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.property_based_error.throw_error(); +``` +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/error-property/test/custom.test.rb b/seed/ruby-sdk-v2/error-property/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/error-property/test/custom.test.rb +++ b/seed/ruby-sdk-v2/error-property/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/errors/reference.md b/seed/ruby-sdk-v2/errors/reference.md new file mode 100644 index 00000000000..01f20563a78 --- /dev/null +++ b/seed/ruby-sdk-v2/errors/reference.md @@ -0,0 +1,127 @@ +# Reference +## Simple +
client.Simple.FooWithoutEndpointError(request) -> Seed::Simple::Types::FooResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.simple.foo_without_endpoint_error({ + bar:'bar' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Simple::Types::FooRequest` + +
+
+
+
+ + +
+
+
+ +
client.Simple.Foo(request) -> Seed::Simple::Types::FooResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.simple.foo({ + bar:'bar' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Simple::Types::FooRequest` + +
+
+
+
+ + +
+
+
+ +
client.Simple.FooWithExamples(request) -> Seed::Simple::Types::FooResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.simple.foo_with_examples({ + bar:'hello' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Simple::Types::FooRequest` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/errors/test/custom.test.rb b/seed/ruby-sdk-v2/errors/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/errors/test/custom.test.rb +++ b/seed/ruby-sdk-v2/errors/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/examples/no-custom-config/reference.md b/seed/ruby-sdk-v2/examples/no-custom-config/reference.md new file mode 100644 index 00000000000..7e482a6fa19 --- /dev/null +++ b/seed/ruby-sdk-v2/examples/no-custom-config/reference.md @@ -0,0 +1,639 @@ +# Reference +
client.Echo(request) -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.create_type(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `String` + +
+
+
+
+ + +
+
+
+ +
client.CreateType(request) -> Seed::Types::Identifier +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.create_type(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Type` + +
+
+
+
+ + +
+
+
+ +## File Notification Service +
client.File.Notification.Service.GetException(NotificationId) -> Seed::Types::Types::Exception +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.file.notification.service.get_exception(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**notificationId:** `String` + +
+
+
+
+ + +
+
+
+ +## File Service +
client.File.Service.GetFile(Filename) -> Seed::Types::Types::File +
+
+ +#### 📝 Description + +
+
+ +
+
+ +This endpoint returns a file by its name. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.file.service.get_file({ + filename:'file.txt', + xFileApiVersion:'0.0.2' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**filename:** `String` — This is a filename + +
+
+
+
+ + +
+
+
+ +## Health Service +
client.Health.Service.Check(Id) -> +
+
+ +#### 📝 Description + +
+
+ +
+
+ +This endpoint checks the health of a resource. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.health.service.check(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The id to check + +
+
+
+
+ + +
+
+
+ +
client.Health.Service.Ping() -> Internal::Types::Boolean +
+
+ +#### 📝 Description + +
+
+ +
+
+ +This endpoint checks the health of the service. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.health.service.ping(); +``` +
+
+
+
+ + +
+
+
+ +## Service +
client.Service.GetMovie(MovieId) -> Seed::Types::Types::Movie +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get_movie(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**movieId:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Service.CreateMovie(request) -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.create_movie({ + id:'movie-c06a4ad7', + prequel:'movie-cv9b914f', + title:'The Boy and the Heron', + from:'Hayao Miyazaki', + rating:8, + type:'movie', + tag:'tag-wf9as23d', + metadata:{}, + revenue:1000000 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Types::Movie` + +
+
+
+
+ + +
+
+
+ +
client.Service.GetMetadata() -> Seed::Types::Types::Metadata +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get_metadata({ + shallow:false, + xApiVersion:'0.0.1' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**shallow:** `Internal::Types::Boolean` + +
+
+ +
+
+ +**tag:** `String` + +
+
+ +
+
+ +**xApiVersion:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Service.CreateBigEntity(request) -> Seed::Types::Types::Response +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.create_big_entity({ + extendedMovie:{ + cast:['cast', 'cast'], + id:'id', + prequel:'prequel', + title:'title', + from:'from', + rating:1.1, + type:'movie', + tag:'tag', + book:'book', + metadata:{}, + revenue:1000000 + }, + entity:{ + name:'name' + }, + commonMetadata:{ + id:'id', + data:{ + data:'data' + }, + jsonString:'jsonString' + }, + migration:{ + name:'name' + }, + node:{ + name:'name', + nodes:[{ + name:'name', + nodes:[{ + name:'name', + nodes:[], + trees:[] + }, { + name:'name', + nodes:[], + trees:[] + }], + trees:[{ + nodes:[] + }, { + nodes:[] + }] + }, { + name:'name', + nodes:[{ + name:'name', + nodes:[], + trees:[] + }, { + name:'name', + nodes:[], + trees:[] + }], + trees:[{ + nodes:[] + }, { + nodes:[] + }] + }], + trees:[{ + nodes:[{ + name:'name', + nodes:[], + trees:[] + }, { + name:'name', + nodes:[], + trees:[] + }] + }, { + nodes:[{ + name:'name', + nodes:[], + trees:[] + }, { + name:'name', + nodes:[], + trees:[] + }] + }] + }, + directory:{ + name:'name', + files:[{ + name:'name', + contents:'contents' + }, { + name:'name', + contents:'contents' + }], + directories:[{ + name:'name', + files:[{ + name:'name', + contents:'contents' + }, { + name:'name', + contents:'contents' + }], + directories:[{ + name:'name', + files:[], + directories:[] + }, { + name:'name', + files:[], + directories:[] + }] + }, { + name:'name', + files:[{ + name:'name', + contents:'contents' + }, { + name:'name', + contents:'contents' + }], + directories:[{ + name:'name', + files:[], + directories:[] + }, { + name:'name', + files:[], + directories:[] + }] + }] + }, + moment:{ + id:'d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', + date:'2023-01-15', + datetime:'2024-01-15T09:30:00Z' + } +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Types::BigEntity` + +
+
+
+
+ + +
+
+
+ +
client.Service.RefreshToken(request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.refresh_token(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Types::RefreshTokenRequest` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/examples/no-custom-config/test/custom.test.rb b/seed/ruby-sdk-v2/examples/no-custom-config/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/examples/no-custom-config/test/custom.test.rb +++ b/seed/ruby-sdk-v2/examples/no-custom-config/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/examples/readme-config/reference.md b/seed/ruby-sdk-v2/examples/readme-config/reference.md new file mode 100644 index 00000000000..7e482a6fa19 --- /dev/null +++ b/seed/ruby-sdk-v2/examples/readme-config/reference.md @@ -0,0 +1,639 @@ +# Reference +
client.Echo(request) -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.create_type(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `String` + +
+
+
+
+ + +
+
+
+ +
client.CreateType(request) -> Seed::Types::Identifier +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.create_type(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Type` + +
+
+
+
+ + +
+
+
+ +## File Notification Service +
client.File.Notification.Service.GetException(NotificationId) -> Seed::Types::Types::Exception +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.file.notification.service.get_exception(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**notificationId:** `String` + +
+
+
+
+ + +
+
+
+ +## File Service +
client.File.Service.GetFile(Filename) -> Seed::Types::Types::File +
+
+ +#### 📝 Description + +
+
+ +
+
+ +This endpoint returns a file by its name. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.file.service.get_file({ + filename:'file.txt', + xFileApiVersion:'0.0.2' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**filename:** `String` — This is a filename + +
+
+
+
+ + +
+
+
+ +## Health Service +
client.Health.Service.Check(Id) -> +
+
+ +#### 📝 Description + +
+
+ +
+
+ +This endpoint checks the health of a resource. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.health.service.check(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The id to check + +
+
+
+
+ + +
+
+
+ +
client.Health.Service.Ping() -> Internal::Types::Boolean +
+
+ +#### 📝 Description + +
+
+ +
+
+ +This endpoint checks the health of the service. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.health.service.ping(); +``` +
+
+
+
+ + +
+
+
+ +## Service +
client.Service.GetMovie(MovieId) -> Seed::Types::Types::Movie +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get_movie(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**movieId:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Service.CreateMovie(request) -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.create_movie({ + id:'movie-c06a4ad7', + prequel:'movie-cv9b914f', + title:'The Boy and the Heron', + from:'Hayao Miyazaki', + rating:8, + type:'movie', + tag:'tag-wf9as23d', + metadata:{}, + revenue:1000000 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Types::Movie` + +
+
+
+
+ + +
+
+
+ +
client.Service.GetMetadata() -> Seed::Types::Types::Metadata +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get_metadata({ + shallow:false, + xApiVersion:'0.0.1' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**shallow:** `Internal::Types::Boolean` + +
+
+ +
+
+ +**tag:** `String` + +
+
+ +
+
+ +**xApiVersion:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Service.CreateBigEntity(request) -> Seed::Types::Types::Response +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.create_big_entity({ + extendedMovie:{ + cast:['cast', 'cast'], + id:'id', + prequel:'prequel', + title:'title', + from:'from', + rating:1.1, + type:'movie', + tag:'tag', + book:'book', + metadata:{}, + revenue:1000000 + }, + entity:{ + name:'name' + }, + commonMetadata:{ + id:'id', + data:{ + data:'data' + }, + jsonString:'jsonString' + }, + migration:{ + name:'name' + }, + node:{ + name:'name', + nodes:[{ + name:'name', + nodes:[{ + name:'name', + nodes:[], + trees:[] + }, { + name:'name', + nodes:[], + trees:[] + }], + trees:[{ + nodes:[] + }, { + nodes:[] + }] + }, { + name:'name', + nodes:[{ + name:'name', + nodes:[], + trees:[] + }, { + name:'name', + nodes:[], + trees:[] + }], + trees:[{ + nodes:[] + }, { + nodes:[] + }] + }], + trees:[{ + nodes:[{ + name:'name', + nodes:[], + trees:[] + }, { + name:'name', + nodes:[], + trees:[] + }] + }, { + nodes:[{ + name:'name', + nodes:[], + trees:[] + }, { + name:'name', + nodes:[], + trees:[] + }] + }] + }, + directory:{ + name:'name', + files:[{ + name:'name', + contents:'contents' + }, { + name:'name', + contents:'contents' + }], + directories:[{ + name:'name', + files:[{ + name:'name', + contents:'contents' + }, { + name:'name', + contents:'contents' + }], + directories:[{ + name:'name', + files:[], + directories:[] + }, { + name:'name', + files:[], + directories:[] + }] + }, { + name:'name', + files:[{ + name:'name', + contents:'contents' + }, { + name:'name', + contents:'contents' + }], + directories:[{ + name:'name', + files:[], + directories:[] + }, { + name:'name', + files:[], + directories:[] + }] + }] + }, + moment:{ + id:'d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', + date:'2023-01-15', + datetime:'2024-01-15T09:30:00Z' + } +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Types::BigEntity` + +
+
+
+
+ + +
+
+
+ +
client.Service.RefreshToken(request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.refresh_token(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Types::RefreshTokenRequest` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/examples/readme-config/test/custom.test.rb b/seed/ruby-sdk-v2/examples/readme-config/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/examples/readme-config/test/custom.test.rb +++ b/seed/ruby-sdk-v2/examples/readme-config/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/examples/reference.md b/seed/ruby-sdk-v2/examples/reference.md new file mode 100644 index 00000000000..7e482a6fa19 --- /dev/null +++ b/seed/ruby-sdk-v2/examples/reference.md @@ -0,0 +1,639 @@ +# Reference +
client.Echo(request) -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.create_type(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `String` + +
+
+
+
+ + +
+
+
+ +
client.CreateType(request) -> Seed::Types::Identifier +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.create_type(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Type` + +
+
+
+
+ + +
+
+
+ +## File Notification Service +
client.File.Notification.Service.GetException(NotificationId) -> Seed::Types::Types::Exception +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.file.notification.service.get_exception(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**notificationId:** `String` + +
+
+
+
+ + +
+
+
+ +## File Service +
client.File.Service.GetFile(Filename) -> Seed::Types::Types::File +
+
+ +#### 📝 Description + +
+
+ +
+
+ +This endpoint returns a file by its name. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.file.service.get_file({ + filename:'file.txt', + xFileApiVersion:'0.0.2' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**filename:** `String` — This is a filename + +
+
+
+
+ + +
+
+
+ +## Health Service +
client.Health.Service.Check(Id) -> +
+
+ +#### 📝 Description + +
+
+ +
+
+ +This endpoint checks the health of a resource. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.health.service.check(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The id to check + +
+
+
+
+ + +
+
+
+ +
client.Health.Service.Ping() -> Internal::Types::Boolean +
+
+ +#### 📝 Description + +
+
+ +
+
+ +This endpoint checks the health of the service. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.health.service.ping(); +``` +
+
+
+
+ + +
+
+
+ +## Service +
client.Service.GetMovie(MovieId) -> Seed::Types::Types::Movie +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get_movie(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**movieId:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Service.CreateMovie(request) -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.create_movie({ + id:'movie-c06a4ad7', + prequel:'movie-cv9b914f', + title:'The Boy and the Heron', + from:'Hayao Miyazaki', + rating:8, + type:'movie', + tag:'tag-wf9as23d', + metadata:{}, + revenue:1000000 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Types::Movie` + +
+
+
+
+ + +
+
+
+ +
client.Service.GetMetadata() -> Seed::Types::Types::Metadata +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get_metadata({ + shallow:false, + xApiVersion:'0.0.1' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**shallow:** `Internal::Types::Boolean` + +
+
+ +
+
+ +**tag:** `String` + +
+
+ +
+
+ +**xApiVersion:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Service.CreateBigEntity(request) -> Seed::Types::Types::Response +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.create_big_entity({ + extendedMovie:{ + cast:['cast', 'cast'], + id:'id', + prequel:'prequel', + title:'title', + from:'from', + rating:1.1, + type:'movie', + tag:'tag', + book:'book', + metadata:{}, + revenue:1000000 + }, + entity:{ + name:'name' + }, + commonMetadata:{ + id:'id', + data:{ + data:'data' + }, + jsonString:'jsonString' + }, + migration:{ + name:'name' + }, + node:{ + name:'name', + nodes:[{ + name:'name', + nodes:[{ + name:'name', + nodes:[], + trees:[] + }, { + name:'name', + nodes:[], + trees:[] + }], + trees:[{ + nodes:[] + }, { + nodes:[] + }] + }, { + name:'name', + nodes:[{ + name:'name', + nodes:[], + trees:[] + }, { + name:'name', + nodes:[], + trees:[] + }], + trees:[{ + nodes:[] + }, { + nodes:[] + }] + }], + trees:[{ + nodes:[{ + name:'name', + nodes:[], + trees:[] + }, { + name:'name', + nodes:[], + trees:[] + }] + }, { + nodes:[{ + name:'name', + nodes:[], + trees:[] + }, { + name:'name', + nodes:[], + trees:[] + }] + }] + }, + directory:{ + name:'name', + files:[{ + name:'name', + contents:'contents' + }, { + name:'name', + contents:'contents' + }], + directories:[{ + name:'name', + files:[{ + name:'name', + contents:'contents' + }, { + name:'name', + contents:'contents' + }], + directories:[{ + name:'name', + files:[], + directories:[] + }, { + name:'name', + files:[], + directories:[] + }] + }, { + name:'name', + files:[{ + name:'name', + contents:'contents' + }, { + name:'name', + contents:'contents' + }], + directories:[{ + name:'name', + files:[], + directories:[] + }, { + name:'name', + files:[], + directories:[] + }] + }] + }, + moment:{ + id:'d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', + date:'2023-01-15', + datetime:'2024-01-15T09:30:00Z' + } +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Types::BigEntity` + +
+
+
+
+ + +
+
+
+ +
client.Service.RefreshToken(request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.refresh_token(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Types::RefreshTokenRequest` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/exhaustive/reference.md b/seed/ruby-sdk-v2/exhaustive/reference.md new file mode 100644 index 00000000000..b26a1428525 --- /dev/null +++ b/seed/ruby-sdk-v2/exhaustive/reference.md @@ -0,0 +1,2283 @@ +# Reference +## Endpoints Container +
client.Endpoints.Container.GetAndReturnListOfPrimitives(request) -> Internal::Types::Array[String] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.container.get_and_return_list_of_primitives(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Internal::Types::Array[String]` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Container.GetAndReturnListOfObjects(request) -> Internal::Types::Array[Seed::Types::Object_::Types::ObjectWithRequiredField] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.container.get_and_return_list_of_objects(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Internal::Types::Array[Seed::Types::Object_::Types::ObjectWithRequiredField]` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Container.GetAndReturnSetOfPrimitives(request) -> Internal::Types::Array[String] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.container.get_and_return_set_of_primitives(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Internal::Types::Array[String]` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Container.GetAndReturnSetOfObjects(request) -> Internal::Types::Array[Seed::Types::Object_::Types::ObjectWithRequiredField] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.container.get_and_return_set_of_objects(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Internal::Types::Array[Seed::Types::Object_::Types::ObjectWithRequiredField]` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Container.GetAndReturnMapPrimToPrim(request) -> Internal::Types::Hash[String, String] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.container.get_and_return_map_prim_to_prim({ + string:'string' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Internal::Types::Hash[String, String]` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Container.GetAndReturnMapOfPrimToObject(request) -> Internal::Types::Hash[String, Seed::Types::Object_::Types::ObjectWithRequiredField] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.container.get_and_return_map_of_prim_to_object({ + string:{ + string:'string' + } +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Internal::Types::Hash[String, Seed::Types::Object_::Types::ObjectWithRequiredField]` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Container.GetAndReturnOptional(request) -> Seed::Types::Object_::Types::ObjectWithRequiredField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.container.get_and_return_optional({ + string:'string' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Object_::Types::ObjectWithRequiredField` + +
+
+
+
+ + +
+
+
+ +## Endpoints ContentType +
client.Endpoints.ContentType.PostJsonPatchContentType(request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.content_type.post_json_patch_content_type({ + string:'string', + integer:1, + long:1000000, + double:1.1, + bool:true, + datetime:'2024-01-15T09:30:00Z', + date:'2023-01-15', + uuid:'d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', + base64:'SGVsbG8gd29ybGQh', + list:['list', 'list'], + set:Set.new(['set']), + map:{ + 1:'map' + }, + bigint:'1000000' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Object_::Types::ObjectWithOptionalField` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.ContentType.PostJsonPatchContentWithCharsetType(request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.content_type.post_json_patch_content_with_charset_type({ + string:'string', + integer:1, + long:1000000, + double:1.1, + bool:true, + datetime:'2024-01-15T09:30:00Z', + date:'2023-01-15', + uuid:'d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', + base64:'SGVsbG8gd29ybGQh', + list:['list', 'list'], + set:Set.new(['set']), + map:{ + 1:'map' + }, + bigint:'1000000' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Object_::Types::ObjectWithOptionalField` + +
+
+
+
+ + +
+
+
+ +## Endpoints Enum +
client.Endpoints.Enum.GetAndReturnEnum(request) -> Seed::Types::Enum::Types::WeatherReport +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.enum.get_and_return_enum(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Enum::Types::WeatherReport` + +
+
+
+
+ + +
+
+
+ +## Endpoints HttpMethods +
client.Endpoints.HttpMethods.TestGet(Id) -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.http_methods.test_get(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.HttpMethods.TestPost(request) -> Seed::Types::Object_::Types::ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.http_methods.test_post({ + string:'string' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Object_::Types::ObjectWithRequiredField` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.HttpMethods.TestPut(Id, request) -> Seed::Types::Object_::Types::ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.http_methods.test_put({ + string:'string' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` + +
+
+ +
+
+ +**request:** `Seed::Types::Object_::Types::ObjectWithRequiredField` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.HttpMethods.TestPatch(Id, request) -> Seed::Types::Object_::Types::ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.http_methods.test_patch({ + string:'string', + integer:1, + long:1000000, + double:1.1, + bool:true, + datetime:'2024-01-15T09:30:00Z', + date:'2023-01-15', + uuid:'d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', + base64:'SGVsbG8gd29ybGQh', + list:['list', 'list'], + set:Set.new(['set']), + map:{ + 1:'map' + }, + bigint:'1000000' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` + +
+
+ +
+
+ +**request:** `Seed::Types::Object_::Types::ObjectWithOptionalField` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.HttpMethods.TestDelete(Id) -> Internal::Types::Boolean +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.http_methods.test_delete(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` + +
+
+
+
+ + +
+
+
+ +## Endpoints Object_ +
client.Endpoints.Object_.GetAndReturnWithOptionalField(request) -> Seed::Types::Object_::Types::ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.object.get_and_return_with_optional_field({ + string:'string', + integer:1, + long:1000000, + double:1.1, + bool:true, + datetime:'2024-01-15T09:30:00Z', + date:'2023-01-15', + uuid:'d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', + base64:'SGVsbG8gd29ybGQh', + list:['list', 'list'], + set:Set.new(['set']), + map:{ + 1:'map' + }, + bigint:'1000000' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Object_::Types::ObjectWithOptionalField` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Object_.GetAndReturnWithRequiredField(request) -> Seed::Types::Object_::Types::ObjectWithRequiredField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.object.get_and_return_with_required_field({ + string:'string' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Object_::Types::ObjectWithRequiredField` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Object_.GetAndReturnWithMapOfMap(request) -> Seed::Types::Object_::Types::ObjectWithMapOfMap +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.object.get_and_return_with_map_of_map({ + map:{ + map:{ + map:'map' + } + } +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Object_::Types::ObjectWithMapOfMap` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Object_.GetAndReturnNestedWithOptionalField(request) -> Seed::Types::Object_::Types::NestedObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.object.get_and_return_nested_with_optional_field({ + string:'string', + NestedObject:{ + string:'string', + integer:1, + long:1000000, + double:1.1, + bool:true, + datetime:'2024-01-15T09:30:00Z', + date:'2023-01-15', + uuid:'d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', + base64:'SGVsbG8gd29ybGQh', + list:['list', 'list'], + set:Set.new(['set']), + map:{ + 1:'map' + }, + bigint:'1000000' + } +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Object_::Types::NestedObjectWithOptionalField` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Object_.GetAndReturnNestedWithRequiredField(String, request) -> Seed::Types::Object_::Types::NestedObjectWithRequiredField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.object.get_and_return_nested_with_required_field({ + string:'string', + NestedObject:{ + string:'string', + integer:1, + long:1000000, + double:1.1, + bool:true, + datetime:'2024-01-15T09:30:00Z', + date:'2023-01-15', + uuid:'d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', + base64:'SGVsbG8gd29ybGQh', + list:['list', 'list'], + set:Set.new(['set']), + map:{ + 1:'map' + }, + bigint:'1000000' + } +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**string:** `String` + +
+
+ +
+
+ +**request:** `Seed::Types::Object_::Types::NestedObjectWithRequiredField` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Object_.GetAndReturnNestedWithRequiredFieldAsList(request) -> Seed::Types::Object_::Types::NestedObjectWithRequiredField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.object.get_and_return_nested_with_required_field_as_list(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Internal::Types::Array[Seed::Types::Object_::Types::NestedObjectWithRequiredField]` + +
+
+
+
+ + +
+
+
+ +## Endpoints Params +
client.Endpoints.Params.GetWithPath(Param) -> String +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with path param +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.params.get_with_path(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Params.GetWithInlinePath(Param) -> String +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with path param +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.params.get_with_path(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Params.GetWithQuery() -> +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with query param +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.params.get_with_query({ + query:'query', + number:1 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**query:** `String` + +
+
+ +
+
+ +**number:** `Integer` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Params.GetWithAllowMultipleQuery() -> +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with multiple of same query param +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.params.get_with_query({ + query:'query', + number:1 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**query:** `String` + +
+
+ +
+
+ +**number:** `Integer` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Params.GetWithPathAndQuery(Param) -> +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with path and query params +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.params.get_with_path_and_query({ + param:'param', + query:'query' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `String` + +
+
+ +
+
+ +**query:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Params.GetWithInlinePathAndQuery(Param) -> +
+
+ +#### 📝 Description + +
+
+ +
+
+ +GET with path and query params +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.params.get_with_path_and_query({ + param:'param', + query:'query' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `String` + +
+
+ +
+
+ +**query:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Params.ModifyWithPath(Param, request) -> String +
+
+ +#### 📝 Description + +
+
+ +
+
+ +PUT to update with path param +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.params.modify_with_inline_path({ + param:'param' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `String` + +
+
+ +
+
+ +**request:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Params.ModifyWithInlinePath(Param, request) -> String +
+
+ +#### 📝 Description + +
+
+ +
+
+ +PUT to update with path param +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.params.modify_with_inline_path({ + param:'param' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**param:** `String` + +
+
+ +
+
+ +**request:** `String` + +
+
+
+
+ + +
+
+
+ +## Endpoints Primitive +
client.Endpoints.Primitive.GetAndReturnString(request) -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.primitive.get_and_return_string(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Primitive.GetAndReturnInt(request) -> Integer +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.primitive.get_and_return_int(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Integer` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Primitive.GetAndReturnLong(request) -> Integer +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.primitive.get_and_return_long(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Integer` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Primitive.GetAndReturnDouble(request) -> Integer +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.primitive.get_and_return_double(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Integer` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Primitive.GetAndReturnBool(request) -> Internal::Types::Boolean +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.primitive.get_and_return_bool(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Internal::Types::Boolean` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Primitive.GetAndReturnDatetime(request) -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.primitive.get_and_return_datetime(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Primitive.GetAndReturnDate(request) -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.primitive.get_and_return_date(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Primitive.GetAndReturnUuid(request) -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.primitive.get_and_return_uuid(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Primitive.GetAndReturnBase64(request) -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.primitive.get_and_return_base_64(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `String` + +
+
+
+
+ + +
+
+
+ +## Endpoints Put +
client.Endpoints.Put.Add(Id) -> Seed::Endpoints::Put::Types::PutResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.put.add({ + id:'id' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` + +
+
+
+
+ + +
+
+
+ +## Endpoints Union +
client.Endpoints.Union.GetAndReturnUnion(request) -> Seed::Types::Union::Types::Animal +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.union.get_and_return_union(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::Union::Types::Animal` + +
+
+
+
+ + +
+
+
+ +## Endpoints Urls +
client.Endpoints.Urls.WithMixedCase() -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.urls.with_mixed_case(); +``` +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Urls.NoEndingSlash() -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.urls.no_ending_slash(); +``` +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Urls.WithEndingSlash() -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.urls.with_ending_slash(); +``` +
+
+
+
+ + +
+
+
+ +
client.Endpoints.Urls.WithUnderscores() -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.endpoints.urls.with_underscores(); +``` +
+
+
+
+ + +
+
+
+ +## InlinedRequests +
client.InlinedRequests.PostWithObjectBodyandResponse(request) -> Seed::Types::Object_::Types::ObjectWithOptionalField +
+
+ +#### 📝 Description + +
+
+ +
+
+ +POST with custom object in request body, response is an object +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.inlined_requests.post_with_object_bodyand_response({ + string:'string', + integer:1, + nestedObject:{ + string:'string', + integer:1, + long:1000000, + double:1.1, + bool:true, + datetime:'2024-01-15T09:30:00Z', + date:'2023-01-15', + uuid:'d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', + base64:'SGVsbG8gd29ybGQh', + list:['list', 'list'], + set:Set.new(['set']), + map:{ + 1:'map' + }, + bigint:'1000000' + } +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**string:** `String` + +
+
+ +
+
+ +**integer:** `Integer` + +
+
+ +
+
+ +**nestedObject:** `Seed::Types::Object_::Types::ObjectWithOptionalField` + +
+
+
+
+ + +
+
+
+ +## NoAuth +
client.NoAuth.PostWithNoAuth(request) -> Internal::Types::Boolean +
+
+ +#### 📝 Description + +
+
+ +
+
+ +POST request with no auth +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.no_auth.post_with_no_auth(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Internal::Types::Hash[String, Object]` + +
+
+
+
+ + +
+
+
+ +## NoReqBody +
client.NoReqBody.GetWithNoRequestBody() -> Seed::Types::Object_::Types::ObjectWithOptionalField +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.no_req_body.get_with_no_request_body(); +``` +
+
+
+
+ + +
+
+
+ +
client.NoReqBody.PostWithNoRequestBody() -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.no_req_body.post_with_no_request_body(); +``` +
+
+
+
+ + +
+
+
+ +## ReqWithHeaders +
client.ReqWithHeaders.GetWithCustomHeader(request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.req_with_headers.get_with_custom_header({ + xTestServiceHeader:'X-TEST-SERVICE-HEADER', + xTestEndpointHeader:'X-TEST-ENDPOINT-HEADER' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**xTestEndpointHeader:** `String` + +
+
+ +
+
+ +**request:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/exhaustive/test/custom.test.rb b/seed/ruby-sdk-v2/exhaustive/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/exhaustive/test/custom.test.rb +++ b/seed/ruby-sdk-v2/exhaustive/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/extends/reference.md b/seed/ruby-sdk-v2/extends/reference.md new file mode 100644 index 00000000000..e3a92411154 --- /dev/null +++ b/seed/ruby-sdk-v2/extends/reference.md @@ -0,0 +1,44 @@ +# Reference +
client.ExtendedInlineRequestBody(request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.extended_inline_request_body({ + name:'name', + docs:'docs', + unique:'unique' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**unique:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/extends/test/custom.test.rb b/seed/ruby-sdk-v2/extends/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/extends/test/custom.test.rb +++ b/seed/ruby-sdk-v2/extends/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/extra-properties/reference.md b/seed/ruby-sdk-v2/extra-properties/reference.md new file mode 100644 index 00000000000..0e97e40c252 --- /dev/null +++ b/seed/ruby-sdk-v2/extra-properties/reference.md @@ -0,0 +1,61 @@ +# Reference +## User +
client.User.CreateUser(request) -> Seed::User::Types::User +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.user.create_user({ + type:'CreateUserRequest', + version:'v1', + name:'name' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**type:** `String` + +
+
+ +
+
+ +**version:** `String` + +
+
+ +
+
+ +**name:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/extra-properties/test/custom.test.rb b/seed/ruby-sdk-v2/extra-properties/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/extra-properties/test/custom.test.rb +++ b/seed/ruby-sdk-v2/extra-properties/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/file-download/reference.md b/seed/ruby-sdk-v2/file-download/reference.md new file mode 100644 index 00000000000..65f34e88fbe --- /dev/null +++ b/seed/ruby-sdk-v2/file-download/reference.md @@ -0,0 +1,26 @@ +# Reference +## Service +
client.Service.Simple() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.simple(); +``` +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/file-download/test/custom.test.rb b/seed/ruby-sdk-v2/file-download/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/file-download/test/custom.test.rb +++ b/seed/ruby-sdk-v2/file-download/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/file-upload/reference.md b/seed/ruby-sdk-v2/file-upload/reference.md new file mode 100644 index 00000000000..65f34e88fbe --- /dev/null +++ b/seed/ruby-sdk-v2/file-upload/reference.md @@ -0,0 +1,26 @@ +# Reference +## Service +
client.Service.Simple() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.simple(); +``` +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/file-upload/test/custom.test.rb b/seed/ruby-sdk-v2/file-upload/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/file-upload/test/custom.test.rb +++ b/seed/ruby-sdk-v2/file-upload/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/folders/reference.md b/seed/ruby-sdk-v2/folders/reference.md new file mode 100644 index 00000000000..ab05e68de9b --- /dev/null +++ b/seed/ruby-sdk-v2/folders/reference.md @@ -0,0 +1,169 @@ +# Reference +
client.Foo() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.foo(); +``` +
+
+
+
+ + +
+
+
+ +## A B +
client.A.B.Foo() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.foo(); +``` +
+
+
+
+ + +
+
+
+ +## A C +
client.A.C.Foo() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.foo(); +``` +
+
+
+
+ + +
+
+
+ +## Folder +
client.Folder.Foo() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.foo(); +``` +
+
+
+
+ + +
+
+
+ +## Folder Service +
client.Folder.Service.Endpoint() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.folder.service.endpoint(); +``` +
+
+
+
+ + +
+
+
+ +
client.Folder.Service.UnknownRequest(request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.folder.service.unknown_request(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Internal::Types::Hash[String, Object]` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/folders/test/custom.test.rb b/seed/ruby-sdk-v2/folders/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/folders/test/custom.test.rb +++ b/seed/ruby-sdk-v2/folders/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/http-head/reference.md b/seed/ruby-sdk-v2/http-head/reference.md new file mode 100644 index 00000000000..064dda307e5 --- /dev/null +++ b/seed/ruby-sdk-v2/http-head/reference.md @@ -0,0 +1,68 @@ +# Reference +## User +
client.User.Head() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.user.head(); +``` +
+
+
+
+ + +
+
+
+ +
client.User.List() -> Internal::Types::Array[Seed::User::Types::User] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.user.list({ + limit:1 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**limit:** `Integer` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/http-head/test/custom.test.rb b/seed/ruby-sdk-v2/http-head/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/http-head/test/custom.test.rb +++ b/seed/ruby-sdk-v2/http-head/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/idempotency-headers/reference.md b/seed/ruby-sdk-v2/idempotency-headers/reference.md new file mode 100644 index 00000000000..f7c77aebd8e --- /dev/null +++ b/seed/ruby-sdk-v2/idempotency-headers/reference.md @@ -0,0 +1,91 @@ +# Reference +## Payment +
client.Payment.Create(request) -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.payment.create({ + amount:1 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**amount:** `Integer` + +
+
+ +
+
+ +**currency:** `Seed::Payment::Types::Currency` + +
+
+
+
+ + +
+
+
+ +
client.Payment.Delete(PaymentId) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.payment.delete(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**paymentId:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/idempotency-headers/test/custom.test.rb b/seed/ruby-sdk-v2/idempotency-headers/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/idempotency-headers/test/custom.test.rb +++ b/seed/ruby-sdk-v2/idempotency-headers/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/imdb/reference.md b/seed/ruby-sdk-v2/imdb/reference.md new file mode 100644 index 00000000000..e5cf2594f5e --- /dev/null +++ b/seed/ruby-sdk-v2/imdb/reference.md @@ -0,0 +1,98 @@ +# Reference +## Imdb +
client.Imdb.CreateMovie(request) -> String +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Add a movie to the database using the movies/* /... path. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.imdb.create_movie({ + title:'title', + rating:1.1 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Imdb::Types::CreateMovieRequest` + +
+
+
+
+ + +
+
+
+ +
client.Imdb.GetMovie(MovieId) -> Seed::Imdb::Types::Movie +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.imdb.get_movie(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**movieId:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/imdb/test/custom.test.rb b/seed/ruby-sdk-v2/imdb/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/imdb/test/custom.test.rb +++ b/seed/ruby-sdk-v2/imdb/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/inferred-auth-explicit/reference.md b/seed/ruby-sdk-v2/inferred-auth-explicit/reference.md new file mode 100644 index 00000000000..d4e575ceb21 --- /dev/null +++ b/seed/ruby-sdk-v2/inferred-auth-explicit/reference.md @@ -0,0 +1,262 @@ +# Reference +## Auth +
client.Auth.GetTokenWithClientCredentials(request) -> Seed::Auth::Types::TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.auth.get_token_with_client_credentials({ + xApiKey:'X-Api-Key', + clientId:'client_id', + clientSecret:'client_secret', + audience:'https://api.example.com', + grantType:'client_credentials', + scope:'scope' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**xApiKey:** `String` + +
+
+ +
+
+ +**clientId:** `String` + +
+
+ +
+
+ +**clientSecret:** `String` + +
+
+ +
+
+ +**audience:** `String` + +
+
+ +
+
+ +**grantType:** `String` + +
+
+ +
+
+ +**scope:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Auth.RefreshToken(request) -> Seed::Auth::Types::TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.auth.refresh_token({ + xApiKey:'X-Api-Key', + clientId:'client_id', + clientSecret:'client_secret', + refreshToken:'refresh_token', + audience:'https://api.example.com', + grantType:'refresh_token', + scope:'scope' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**xApiKey:** `String` + +
+
+ +
+
+ +**clientId:** `String` + +
+
+ +
+
+ +**clientSecret:** `String` + +
+
+ +
+
+ +**refreshToken:** `String` + +
+
+ +
+
+ +**audience:** `String` + +
+
+ +
+
+ +**grantType:** `String` + +
+
+ +
+
+ +**scope:** `String` + +
+
+
+
+ + +
+
+
+ +## NestedNoAuth Api +
client.NestedNoAuth.Api.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nested_no_auth.api.get_something(); +``` +
+
+
+
+ + +
+
+
+ +## Nested Api +
client.Nested.Api.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nested.api.get_something(); +``` +
+
+
+
+ + +
+
+
+ +## Simple +
client.Simple.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.simple.get_something(); +``` +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/inferred-auth-explicit/test/custom.test.rb b/seed/ruby-sdk-v2/inferred-auth-explicit/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/inferred-auth-explicit/test/custom.test.rb +++ b/seed/ruby-sdk-v2/inferred-auth-explicit/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/inferred-auth-implicit-no-expiry/reference.md b/seed/ruby-sdk-v2/inferred-auth-implicit-no-expiry/reference.md new file mode 100644 index 00000000000..d4e575ceb21 --- /dev/null +++ b/seed/ruby-sdk-v2/inferred-auth-implicit-no-expiry/reference.md @@ -0,0 +1,262 @@ +# Reference +## Auth +
client.Auth.GetTokenWithClientCredentials(request) -> Seed::Auth::Types::TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.auth.get_token_with_client_credentials({ + xApiKey:'X-Api-Key', + clientId:'client_id', + clientSecret:'client_secret', + audience:'https://api.example.com', + grantType:'client_credentials', + scope:'scope' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**xApiKey:** `String` + +
+
+ +
+
+ +**clientId:** `String` + +
+
+ +
+
+ +**clientSecret:** `String` + +
+
+ +
+
+ +**audience:** `String` + +
+
+ +
+
+ +**grantType:** `String` + +
+
+ +
+
+ +**scope:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Auth.RefreshToken(request) -> Seed::Auth::Types::TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.auth.refresh_token({ + xApiKey:'X-Api-Key', + clientId:'client_id', + clientSecret:'client_secret', + refreshToken:'refresh_token', + audience:'https://api.example.com', + grantType:'refresh_token', + scope:'scope' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**xApiKey:** `String` + +
+
+ +
+
+ +**clientId:** `String` + +
+
+ +
+
+ +**clientSecret:** `String` + +
+
+ +
+
+ +**refreshToken:** `String` + +
+
+ +
+
+ +**audience:** `String` + +
+
+ +
+
+ +**grantType:** `String` + +
+
+ +
+
+ +**scope:** `String` + +
+
+
+
+ + +
+
+
+ +## NestedNoAuth Api +
client.NestedNoAuth.Api.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nested_no_auth.api.get_something(); +``` +
+
+
+
+ + +
+
+
+ +## Nested Api +
client.Nested.Api.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nested.api.get_something(); +``` +
+
+
+
+ + +
+
+
+ +## Simple +
client.Simple.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.simple.get_something(); +``` +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/inferred-auth-implicit-no-expiry/test/custom.test.rb b/seed/ruby-sdk-v2/inferred-auth-implicit-no-expiry/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/inferred-auth-implicit-no-expiry/test/custom.test.rb +++ b/seed/ruby-sdk-v2/inferred-auth-implicit-no-expiry/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/inferred-auth-implicit/reference.md b/seed/ruby-sdk-v2/inferred-auth-implicit/reference.md new file mode 100644 index 00000000000..d4e575ceb21 --- /dev/null +++ b/seed/ruby-sdk-v2/inferred-auth-implicit/reference.md @@ -0,0 +1,262 @@ +# Reference +## Auth +
client.Auth.GetTokenWithClientCredentials(request) -> Seed::Auth::Types::TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.auth.get_token_with_client_credentials({ + xApiKey:'X-Api-Key', + clientId:'client_id', + clientSecret:'client_secret', + audience:'https://api.example.com', + grantType:'client_credentials', + scope:'scope' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**xApiKey:** `String` + +
+
+ +
+
+ +**clientId:** `String` + +
+
+ +
+
+ +**clientSecret:** `String` + +
+
+ +
+
+ +**audience:** `String` + +
+
+ +
+
+ +**grantType:** `String` + +
+
+ +
+
+ +**scope:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Auth.RefreshToken(request) -> Seed::Auth::Types::TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.auth.refresh_token({ + xApiKey:'X-Api-Key', + clientId:'client_id', + clientSecret:'client_secret', + refreshToken:'refresh_token', + audience:'https://api.example.com', + grantType:'refresh_token', + scope:'scope' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**xApiKey:** `String` + +
+
+ +
+
+ +**clientId:** `String` + +
+
+ +
+
+ +**clientSecret:** `String` + +
+
+ +
+
+ +**refreshToken:** `String` + +
+
+ +
+
+ +**audience:** `String` + +
+
+ +
+
+ +**grantType:** `String` + +
+
+ +
+
+ +**scope:** `String` + +
+
+
+
+ + +
+
+
+ +## NestedNoAuth Api +
client.NestedNoAuth.Api.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nested_no_auth.api.get_something(); +``` +
+
+
+
+ + +
+
+
+ +## Nested Api +
client.Nested.Api.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nested.api.get_something(); +``` +
+
+
+
+ + +
+
+
+ +## Simple +
client.Simple.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.simple.get_something(); +``` +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/inferred-auth-implicit/test/custom.test.rb b/seed/ruby-sdk-v2/inferred-auth-implicit/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/inferred-auth-implicit/test/custom.test.rb +++ b/seed/ruby-sdk-v2/inferred-auth-implicit/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/license/reference.md b/seed/ruby-sdk-v2/license/reference.md new file mode 100644 index 00000000000..7c452e7c5fd --- /dev/null +++ b/seed/ruby-sdk-v2/license/reference.md @@ -0,0 +1,25 @@ +# Reference +
client.Get() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.get(); +``` +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/license/test/custom.test.rb b/seed/ruby-sdk-v2/license/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/license/test/custom.test.rb +++ b/seed/ruby-sdk-v2/license/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/literal/reference.md b/seed/ruby-sdk-v2/literal/reference.md new file mode 100644 index 00000000000..c04c27dfa47 --- /dev/null +++ b/seed/ruby-sdk-v2/literal/reference.md @@ -0,0 +1,380 @@ +# Reference +## Headers +
client.Headers.Send(request) -> Seed::Types::SendResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.headers.send_({ + endpointVersion:'02-12-2024', + async:true, + query:'What is the weather today' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**endpointVersion:** `String` + +
+
+ +
+
+ +**async:** `Internal::Types::Boolean` + +
+
+ +
+
+ +**query:** `String` + +
+
+
+
+ + +
+
+
+ +## Inlined +
client.Inlined.Send(request) -> Seed::Types::SendResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.inlined.send_({ + temperature:10.1, + prompt:'You are a helpful assistant', + context:"You're super wise", + aliasedContext:"You're super wise", + maybeContext:"You're super wise", + objectWithLiteral:{ + nestedLiteral:{ + myLiteral:'How super cool' + } + }, + stream:false, + query:'What is the weather today' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**prompt:** `String` + +
+
+ +
+
+ +**context:** `String` + +
+
+ +
+
+ +**query:** `String` + +
+
+ +
+
+ +**temperature:** `Integer` + +
+
+ +
+
+ +**stream:** `Internal::Types::Boolean` + +
+
+ +
+
+ +**aliasedContext:** `String` + +
+
+ +
+
+ +**maybeContext:** `String` + +
+
+ +
+
+ +**objectWithLiteral:** `Seed::Inlined::Types::ATopLevelLiteral` + +
+
+
+
+ + +
+
+
+ +## Path +
client.Path.Send(Id) -> Seed::Types::SendResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.path.send_(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` + +
+
+
+
+ + +
+
+
+ +## Query +
client.Query.Send() -> Seed::Types::SendResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.query.send_({ + prompt:'You are a helpful assistant', + optionalPrompt:'You are a helpful assistant', + aliasPrompt:'You are a helpful assistant', + aliasOptionalPrompt:'You are a helpful assistant', + stream:false, + optionalStream:false, + aliasStream:false, + aliasOptionalStream:false, + query:'What is the weather today' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**prompt:** `String` + +
+
+ +
+
+ +**optionalPrompt:** `String` + +
+
+ +
+
+ +**aliasPrompt:** `String` + +
+
+ +
+
+ +**aliasOptionalPrompt:** `String` + +
+
+ +
+
+ +**query:** `String` + +
+
+ +
+
+ +**stream:** `Internal::Types::Boolean` + +
+
+ +
+
+ +**optionalStream:** `Internal::Types::Boolean` + +
+
+ +
+
+ +**aliasStream:** `Internal::Types::Boolean` + +
+
+ +
+
+ +**aliasOptionalStream:** `Internal::Types::Boolean` + +
+
+
+
+ + +
+
+
+ +## Reference +
client.Reference.Send(request) -> Seed::Types::SendResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.reference.send_({ + prompt:'You are a helpful assistant', + stream:false, + context:"You're super wise", + query:'What is the weather today', + containerObject:{ + nestedObjects:[{ + literal1:'literal1', + literal2:'literal2', + strProp:'strProp' + }] + } +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Reference::Types::SendRequest` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/literal/test/custom.test.rb b/seed/ruby-sdk-v2/literal/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/literal/test/custom.test.rb +++ b/seed/ruby-sdk-v2/literal/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/literals-unions/reference.md b/seed/ruby-sdk-v2/literals-unions/reference.md new file mode 100644 index 00000000000..4a938e09d06 --- /dev/null +++ b/seed/ruby-sdk-v2/literals-unions/reference.md @@ -0,0 +1 @@ +# Reference \ No newline at end of file diff --git a/seed/ruby-sdk-v2/literals-unions/test/custom.test.rb b/seed/ruby-sdk-v2/literals-unions/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/literals-unions/test/custom.test.rb +++ b/seed/ruby-sdk-v2/literals-unions/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/mixed-case/reference.md b/seed/ruby-sdk-v2/mixed-case/reference.md new file mode 100644 index 00000000000..4002f91e61d --- /dev/null +++ b/seed/ruby-sdk-v2/mixed-case/reference.md @@ -0,0 +1,92 @@ +# Reference +## Service +
client.Service.GetResource(ResourceId) -> Seed::Service::Types::Resource +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get_resource(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**resourceId:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Service.ListResources() -> Internal::Types::Array[Seed::Service::Types::Resource] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.list_resources({ + pageLimit:10, + beforeDate:'2023-01-01' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**pageLimit:** `Integer` + +
+
+ +
+
+ +**beforeDate:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/mixed-case/test/custom.test.rb b/seed/ruby-sdk-v2/mixed-case/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/mixed-case/test/custom.test.rb +++ b/seed/ruby-sdk-v2/mixed-case/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/mixed-file-directory/reference.md b/seed/ruby-sdk-v2/mixed-file-directory/reference.md new file mode 100644 index 00000000000..f94e98717e6 --- /dev/null +++ b/seed/ruby-sdk-v2/mixed-file-directory/reference.md @@ -0,0 +1,228 @@ +# Reference +## Organization +
client.Organization.Create(request) -> Seed::Organization::Types::Organization +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Create a new organization. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.organization.create({ + name:'name' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Organization::Types::CreateOrganizationRequest` + +
+
+
+
+ + +
+
+
+ +## User +
client.User.List() -> Internal::Types::Array[Seed::User::Types::User] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +List all users. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.user.list({ + limit:1 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**limit:** `Integer` — The maximum number of results to return. + +
+
+
+
+ + +
+
+
+ +## User Events +
client.User.Events.ListEvents() -> Internal::Types::Array[Seed::User::Events::Types::Event] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +List all user events. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.user.events.list_events({ + limit:1 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**limit:** `Integer` — The maximum number of results to return. + +
+
+
+
+ + +
+
+
+ +## User Events Metadata +
client.User.Events.Metadata.GetMetadata() -> Seed::User::Events::Metadata::Types::Metadata +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Get event metadata. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.user.events.metadata.get_metadata({ + id:'id' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/mixed-file-directory/test/custom.test.rb b/seed/ruby-sdk-v2/mixed-file-directory/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/mixed-file-directory/test/custom.test.rb +++ b/seed/ruby-sdk-v2/mixed-file-directory/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/multi-line-docs/reference.md b/seed/ruby-sdk-v2/multi-line-docs/reference.md new file mode 100644 index 00000000000..0eeaab93f1e --- /dev/null +++ b/seed/ruby-sdk-v2/multi-line-docs/reference.md @@ -0,0 +1,131 @@ +# Reference +## User +
client.User.GetUser(UserId) -> +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve a user. +This endpoint is used to retrieve a user. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.user.get_user(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**userId:** `String` + +The ID of the user to retrieve. +This ID is unique to each user. + +
+
+
+
+ + +
+
+
+ +
client.User.CreateUser(request) -> Seed::User::Types::User +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Create a new user. +This endpoint is used to create a new user. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.user.create_user({ + name:'name', + age:1 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**name:** `String` + +The name of the user to create. +This name is unique to each user. + +
+
+ +
+
+ +**age:** `Integer` + +The age of the user. +This property is not required. + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/multi-line-docs/test/custom.test.rb b/seed/ruby-sdk-v2/multi-line-docs/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/multi-line-docs/test/custom.test.rb +++ b/seed/ruby-sdk-v2/multi-line-docs/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/multi-url-environment-no-default/reference.md b/seed/ruby-sdk-v2/multi-url-environment-no-default/reference.md new file mode 100644 index 00000000000..51c742e84a8 --- /dev/null +++ b/seed/ruby-sdk-v2/multi-url-environment-no-default/reference.md @@ -0,0 +1,86 @@ +# Reference +## Ec2 +
client.Ec2.BootInstance(request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.ec_2.boot_instance({ + size:'size' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**size:** `String` + +
+
+
+
+ + +
+
+
+ +## S3 +
client.S3.GetPresignedUrl(request) -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.s_3.get_presigned_url({ + s3Key:'s3Key' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**s3Key:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/multi-url-environment-no-default/test/custom.test.rb b/seed/ruby-sdk-v2/multi-url-environment-no-default/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/multi-url-environment-no-default/test/custom.test.rb +++ b/seed/ruby-sdk-v2/multi-url-environment-no-default/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/multi-url-environment/reference.md b/seed/ruby-sdk-v2/multi-url-environment/reference.md new file mode 100644 index 00000000000..51c742e84a8 --- /dev/null +++ b/seed/ruby-sdk-v2/multi-url-environment/reference.md @@ -0,0 +1,86 @@ +# Reference +## Ec2 +
client.Ec2.BootInstance(request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.ec_2.boot_instance({ + size:'size' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**size:** `String` + +
+
+
+
+ + +
+
+
+ +## S3 +
client.S3.GetPresignedUrl(request) -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.s_3.get_presigned_url({ + s3Key:'s3Key' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**s3Key:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/multi-url-environment/test/custom.test.rb b/seed/ruby-sdk-v2/multi-url-environment/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/multi-url-environment/test/custom.test.rb +++ b/seed/ruby-sdk-v2/multi-url-environment/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/multiple-request-bodies/reference.md b/seed/ruby-sdk-v2/multiple-request-bodies/reference.md new file mode 100644 index 00000000000..56fcc8e6009 --- /dev/null +++ b/seed/ruby-sdk-v2/multiple-request-bodies/reference.md @@ -0,0 +1,56 @@ +# Reference +
client.UploadJsonDocument(request) -> Seed::Types::UploadDocumentResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.upload_json_document({}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**author:** `String` + +
+
+ +
+
+ +**tags:** `Internal::Types::Array[String]` + +
+
+ +
+
+ +**title:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/multiple-request-bodies/test/custom.test.rb b/seed/ruby-sdk-v2/multiple-request-bodies/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/multiple-request-bodies/test/custom.test.rb +++ b/seed/ruby-sdk-v2/multiple-request-bodies/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/no-environment/reference.md b/seed/ruby-sdk-v2/no-environment/reference.md new file mode 100644 index 00000000000..32c15caa385 --- /dev/null +++ b/seed/ruby-sdk-v2/no-environment/reference.md @@ -0,0 +1,26 @@ +# Reference +## Dummy +
client.Dummy.GetDummy() -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.dummy.get_dummy(); +``` +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/no-environment/test/custom.test.rb b/seed/ruby-sdk-v2/no-environment/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/no-environment/test/custom.test.rb +++ b/seed/ruby-sdk-v2/no-environment/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/nullable-optional/reference.md b/seed/ruby-sdk-v2/nullable-optional/reference.md new file mode 100644 index 00000000000..87efb1897d4 --- /dev/null +++ b/seed/ruby-sdk-v2/nullable-optional/reference.md @@ -0,0 +1,948 @@ +# Reference +## NullableOptional +
client.NullableOptional.GetUser(UserId) -> Seed::NullableOptional::Types::UserResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Get a user by ID +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nullable_optional.get_user(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**userId:** `String` + +
+
+
+
+ + +
+
+
+ +
client.NullableOptional.CreateUser(request) -> Seed::NullableOptional::Types::UserResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Create a new user +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nullable_optional.create_user({ + username:'username', + email:'email', + phone:'phone', + address:{ + street:'street', + city:'city', + state:'state', + zipCode:'zipCode', + country:'country', + buildingId:'buildingId', + tenantId:'tenantId' + } +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::NullableOptional::Types::CreateUserRequest` + +
+
+
+
+ + +
+
+
+ +
client.NullableOptional.UpdateUser(UserId, request) -> Seed::NullableOptional::Types::UserResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Update a user (partial update) +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nullable_optional.update_user({ + username:'username', + email:'email', + phone:'phone', + address:{ + street:'street', + city:'city', + state:'state', + zipCode:'zipCode', + country:'country', + buildingId:'buildingId', + tenantId:'tenantId' + } +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**userId:** `String` + +
+
+ +
+
+ +**request:** `Seed::NullableOptional::Types::UpdateUserRequest` + +
+
+
+
+ + +
+
+
+ +
client.NullableOptional.ListUsers() -> Internal::Types::Array[Seed::NullableOptional::Types::UserResponse] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +List all users +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nullable_optional.list_users({ + limit:1, + offset:1, + includeDeleted:true, + sortBy:'sortBy' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**limit:** `Integer` + +
+
+ +
+
+ +**offset:** `Integer` + +
+
+ +
+
+ +**includeDeleted:** `Internal::Types::Boolean` + +
+
+ +
+
+ +**sortBy:** `String` + +
+
+
+
+ + +
+
+
+ +
client.NullableOptional.SearchUsers() -> Internal::Types::Array[Seed::NullableOptional::Types::UserResponse] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Search users +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nullable_optional.search_users({ + query:'query', + department:'department', + role:'role', + isActive:true +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**query:** `String` + +
+
+ +
+
+ +**department:** `String` + +
+
+ +
+
+ +**role:** `String` + +
+
+ +
+
+ +**isActive:** `Internal::Types::Boolean` + +
+
+
+
+ + +
+
+
+ +
client.NullableOptional.CreateComplexProfile(request) -> Seed::NullableOptional::Types::ComplexProfile +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Create a complex profile to test nullable enums and unions +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nullable_optional.create_complex_profile({ + id:'id', + nullableArray:['nullableArray', 'nullableArray'], + optionalArray:['optionalArray', 'optionalArray'], + optionalNullableArray:['optionalNullableArray', 'optionalNullableArray'], + nullableListOfNullables:['nullableListOfNullables', 'nullableListOfNullables'], + nullableMapOfNullables:{ + nullableMapOfNullables:{ + street:'street', + city:'city', + state:'state', + zipCode:'zipCode', + country:'country', + buildingId:'buildingId', + tenantId:'tenantId' + } + }, + nullableListOfUnions:[], + optionalMapOfEnums:{} +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::NullableOptional::Types::ComplexProfile` + +
+
+
+
+ + +
+
+
+ +
client.NullableOptional.GetComplexProfile(ProfileId) -> Seed::NullableOptional::Types::ComplexProfile +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Get a complex profile by ID +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nullable_optional.get_complex_profile(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**profileId:** `String` + +
+
+
+
+ + +
+
+
+ +
client.NullableOptional.UpdateComplexProfile(ProfileId, request) -> Seed::NullableOptional::Types::ComplexProfile +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Update complex profile to test nullable field updates +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nullable_optional.update_complex_profile({ + profileId:'profileId', + nullableArray:['nullableArray', 'nullableArray'] +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**profileId:** `String` + +
+
+ +
+
+ +**nullableRole:** `Seed::NullableOptional::Types::UserRole` + +
+
+ +
+
+ +**nullableStatus:** `Seed::NullableOptional::Types::UserStatus` + +
+
+ +
+
+ +**nullableNotification:** `Seed::NullableOptional::Types::NotificationMethod` + +
+
+ +
+
+ +**nullableSearchResult:** `Seed::NullableOptional::Types::SearchResult` + +
+
+ +
+
+ +**nullableArray:** `Internal::Types::Array[String]` + +
+
+
+
+ + +
+
+
+ +
client.NullableOptional.TestDeserialization(request) -> Seed::NullableOptional::Types::DeserializationTestResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Test endpoint for validating null deserialization +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nullable_optional.test_deserialization({ + requiredString:'requiredString', + nullableString:'nullableString', + optionalString:'optionalString', + optionalNullableString:'optionalNullableString', + nullableList:['nullableList', 'nullableList'], + nullableMap:{ + nullableMap:1 + }, + nullableObject:{ + street:'street', + city:'city', + state:'state', + zipCode:'zipCode', + country:'country', + buildingId:'buildingId', + tenantId:'tenantId' + }, + optionalObject:{ + id:'id', + name:'name', + domain:'domain', + employeeCount:1 + } +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::NullableOptional::Types::DeserializationTestRequest` + +
+
+
+
+ + +
+
+
+ +
client.NullableOptional.FilterByRole() -> Internal::Types::Array[Seed::NullableOptional::Types::UserResponse] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Filter users by role with nullable enum +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nullable_optional.filter_by_role({}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**role:** `Seed::NullableOptional::Types::UserRole` + +
+
+ +
+
+ +**status:** `Seed::NullableOptional::Types::UserStatus` + +
+
+ +
+
+ +**secondaryRole:** `Seed::NullableOptional::Types::UserRole` + +
+
+
+
+ + +
+
+
+ +
client.NullableOptional.GetNotificationSettings(UserId) -> Seed::NullableOptional::Types::NotificationMethod +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Get notification settings which may be null +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nullable_optional.get_notification_settings(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**userId:** `String` + +
+
+
+
+ + +
+
+
+ +
client.NullableOptional.UpdateTags(UserId, request) -> Internal::Types::Array[String] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Update tags to test array handling +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nullable_optional.update_tags({ + userId:'userId', + tags:['tags', 'tags'], + categories:['categories', 'categories'], + labels:['labels', 'labels'] +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**userId:** `String` + +
+
+ +
+
+ +**tags:** `Internal::Types::Array[String]` + +
+
+ +
+
+ +**categories:** `Internal::Types::Array[String]` + +
+
+ +
+
+ +**labels:** `Internal::Types::Array[String]` + +
+
+
+
+ + +
+
+
+ +
client.NullableOptional.GetSearchResults(request) -> Internal::Types::Array[Seed::NullableOptional::Types::SearchResult] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Get search results with nullable unions +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nullable_optional.get_search_results({ + query:'query', + filters:{ + filters:'filters' + }, + includeTypes:['includeTypes', 'includeTypes'] +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**query:** `String` + +
+
+ +
+
+ +**filters:** `Internal::Types::Hash[String, String]` + +
+
+ +
+
+ +**includeTypes:** `Internal::Types::Array[String]` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/nullable-optional/test/custom.test.rb b/seed/ruby-sdk-v2/nullable-optional/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/nullable-optional/test/custom.test.rb +++ b/seed/ruby-sdk-v2/nullable-optional/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/nullable/reference.md b/seed/ruby-sdk-v2/nullable/reference.md new file mode 100644 index 00000000000..a4192f4a380 --- /dev/null +++ b/seed/ruby-sdk-v2/nullable/reference.md @@ -0,0 +1,195 @@ +# Reference +## Nullable +
client.Nullable.GetUsers() -> Internal::Types::Array[Seed::Nullable::Types::User] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nullable.get_users({ + avatar:'avatar', + extra:true +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**usernames:** `String` + +
+
+ +
+
+ +**avatar:** `String` + +
+
+ +
+
+ +**activated:** `Internal::Types::Boolean` + +
+
+ +
+
+ +**tags:** `String` + +
+
+ +
+
+ +**extra:** `Internal::Types::Boolean` + +
+
+
+
+ + +
+
+
+ +
client.Nullable.CreateUser(request) -> Seed::Nullable::Types::User +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nullable.create_user({ + username:'username', + tags:['tags', 'tags'], + metadata:{ + createdAt:'2024-01-15T09:30:00Z', + updatedAt:'2024-01-15T09:30:00Z', + avatar:'avatar', + activated:true, + values:{ + values:'values' + } + }, + avatar:'avatar' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**username:** `String` + +
+
+ +
+
+ +**tags:** `Internal::Types::Array[String]` + +
+
+ +
+
+ +**metadata:** `Seed::Nullable::Types::Metadata` + +
+
+ +
+
+ +**avatar:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Nullable.DeleteUser(request) -> Internal::Types::Boolean +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nullable.delete_user({ + username:'xy' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**username:** `String` — The user to delete. + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/nullable/test/custom.test.rb b/seed/ruby-sdk-v2/nullable/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/nullable/test/custom.test.rb +++ b/seed/ruby-sdk-v2/nullable/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/oauth-client-credentials-custom/reference.md b/seed/ruby-sdk-v2/oauth-client-credentials-custom/reference.md new file mode 100644 index 00000000000..dc87eadbbfe --- /dev/null +++ b/seed/ruby-sdk-v2/oauth-client-credentials-custom/reference.md @@ -0,0 +1,262 @@ +# Reference +## Auth +
client.Auth.GetTokenWithClientCredentials(request) -> Seed::Auth::Types::TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.auth.get_token_with_client_credentials({ + cid:'cid', + csr:'csr', + scp:'scp', + entityId:'entity_id', + audience:'https://api.example.com', + grantType:'client_credentials', + scope:'scope' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cid:** `String` + +
+
+ +
+
+ +**csr:** `String` + +
+
+ +
+
+ +**scp:** `String` + +
+
+ +
+
+ +**entityId:** `String` + +
+
+ +
+
+ +**audience:** `String` + +
+
+ +
+
+ +**grantType:** `String` + +
+
+ +
+
+ +**scope:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Auth.RefreshToken(request) -> Seed::Auth::Types::TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.auth.refresh_token({ + clientId:'client_id', + clientSecret:'client_secret', + refreshToken:'refresh_token', + audience:'https://api.example.com', + grantType:'refresh_token', + scope:'scope' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**clientId:** `String` + +
+
+ +
+
+ +**clientSecret:** `String` + +
+
+ +
+
+ +**refreshToken:** `String` + +
+
+ +
+
+ +**audience:** `String` + +
+
+ +
+
+ +**grantType:** `String` + +
+
+ +
+
+ +**scope:** `String` + +
+
+
+
+ + +
+
+
+ +## NestedNoAuth Api +
client.NestedNoAuth.Api.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nested_no_auth.api.get_something(); +``` +
+
+
+
+ + +
+
+
+ +## Nested Api +
client.Nested.Api.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nested.api.get_something(); +``` +
+
+
+
+ + +
+
+
+ +## Simple +
client.Simple.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.simple.get_something(); +``` +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/oauth-client-credentials-custom/test/custom.test.rb b/seed/ruby-sdk-v2/oauth-client-credentials-custom/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/oauth-client-credentials-custom/test/custom.test.rb +++ b/seed/ruby-sdk-v2/oauth-client-credentials-custom/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/oauth-client-credentials-default/reference.md b/seed/ruby-sdk-v2/oauth-client-credentials-default/reference.md new file mode 100644 index 00000000000..243e1b9b6a2 --- /dev/null +++ b/seed/ruby-sdk-v2/oauth-client-credentials-default/reference.md @@ -0,0 +1,139 @@ +# Reference +## Auth +
client.Auth.GetToken(request) -> Seed::Auth::Types::TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.auth.get_token({ + clientId:'client_id', + clientSecret:'client_secret', + grantType:'client_credentials' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**clientId:** `String` + +
+
+ +
+
+ +**clientSecret:** `String` + +
+
+ +
+
+ +**grantType:** `String` + +
+
+
+
+ + +
+
+
+ +## NestedNoAuth Api +
client.NestedNoAuth.Api.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nested_no_auth.api.get_something(); +``` +
+
+
+
+ + +
+
+
+ +## Nested Api +
client.Nested.Api.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nested.api.get_something(); +``` +
+
+
+
+ + +
+
+
+ +## Simple +
client.Simple.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.simple.get_something(); +``` +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/oauth-client-credentials-default/test/custom.test.rb b/seed/ruby-sdk-v2/oauth-client-credentials-default/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/oauth-client-credentials-default/test/custom.test.rb +++ b/seed/ruby-sdk-v2/oauth-client-credentials-default/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/oauth-client-credentials-environment-variables/reference.md b/seed/ruby-sdk-v2/oauth-client-credentials-environment-variables/reference.md new file mode 100644 index 00000000000..4f4483fcb63 --- /dev/null +++ b/seed/ruby-sdk-v2/oauth-client-credentials-environment-variables/reference.md @@ -0,0 +1,244 @@ +# Reference +## Auth +
client.Auth.GetTokenWithClientCredentials(request) -> Seed::Auth::Types::TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.auth.get_token_with_client_credentials({ + clientId:'client_id', + clientSecret:'client_secret', + audience:'https://api.example.com', + grantType:'client_credentials', + scope:'scope' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**clientId:** `String` + +
+
+ +
+
+ +**clientSecret:** `String` + +
+
+ +
+
+ +**audience:** `String` + +
+
+ +
+
+ +**grantType:** `String` + +
+
+ +
+
+ +**scope:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Auth.RefreshToken(request) -> Seed::Auth::Types::TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.auth.refresh_token({ + clientId:'client_id', + clientSecret:'client_secret', + refreshToken:'refresh_token', + audience:'https://api.example.com', + grantType:'refresh_token', + scope:'scope' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**clientId:** `String` + +
+
+ +
+
+ +**clientSecret:** `String` + +
+
+ +
+
+ +**refreshToken:** `String` + +
+
+ +
+
+ +**audience:** `String` + +
+
+ +
+
+ +**grantType:** `String` + +
+
+ +
+
+ +**scope:** `String` + +
+
+
+
+ + +
+
+
+ +## NestedNoAuth Api +
client.NestedNoAuth.Api.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nested_no_auth.api.get_something(); +``` +
+
+
+
+ + +
+
+
+ +## Nested Api +
client.Nested.Api.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nested.api.get_something(); +``` +
+
+
+
+ + +
+
+
+ +## Simple +
client.Simple.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.simple.get_something(); +``` +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/oauth-client-credentials-environment-variables/test/custom.test.rb b/seed/ruby-sdk-v2/oauth-client-credentials-environment-variables/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/oauth-client-credentials-environment-variables/test/custom.test.rb +++ b/seed/ruby-sdk-v2/oauth-client-credentials-environment-variables/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/oauth-client-credentials-nested-root/reference.md b/seed/ruby-sdk-v2/oauth-client-credentials-nested-root/reference.md new file mode 100644 index 00000000000..954ad012169 --- /dev/null +++ b/seed/ruby-sdk-v2/oauth-client-credentials-nested-root/reference.md @@ -0,0 +1,157 @@ +# Reference +## Auth +
client.Auth.GetToken(request) -> Seed::Auth::Types::TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.auth.get_token({ + clientId:'client_id', + clientSecret:'client_secret', + audience:'https://api.example.com', + grantType:'client_credentials', + scope:'scope' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**clientId:** `String` + +
+
+ +
+
+ +**clientSecret:** `String` + +
+
+ +
+
+ +**audience:** `String` + +
+
+ +
+
+ +**grantType:** `String` + +
+
+ +
+
+ +**scope:** `String` + +
+
+
+
+ + +
+
+
+ +## NestedNoAuth Api +
client.NestedNoAuth.Api.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nested_no_auth.api.get_something(); +``` +
+
+
+
+ + +
+
+
+ +## Nested Api +
client.Nested.Api.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nested.api.get_something(); +``` +
+
+
+
+ + +
+
+
+ +## Simple +
client.Simple.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.simple.get_something(); +``` +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/oauth-client-credentials-nested-root/test/custom.test.rb b/seed/ruby-sdk-v2/oauth-client-credentials-nested-root/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/oauth-client-credentials-nested-root/test/custom.test.rb +++ b/seed/ruby-sdk-v2/oauth-client-credentials-nested-root/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/oauth-client-credentials-with-variables/reference.md b/seed/ruby-sdk-v2/oauth-client-credentials-with-variables/reference.md new file mode 100644 index 00000000000..b24902f1cbc --- /dev/null +++ b/seed/ruby-sdk-v2/oauth-client-credentials-with-variables/reference.md @@ -0,0 +1,285 @@ +# Reference +## Auth +
client.Auth.GetTokenWithClientCredentials(request) -> Seed::Auth::Types::TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.auth.get_token_with_client_credentials({ + clientId:'client_id', + clientSecret:'client_secret', + audience:'https://api.example.com', + grantType:'client_credentials', + scope:'scope' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**clientId:** `String` + +
+
+ +
+
+ +**clientSecret:** `String` + +
+
+ +
+
+ +**audience:** `String` + +
+
+ +
+
+ +**grantType:** `String` + +
+
+ +
+
+ +**scope:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Auth.RefreshToken(request) -> Seed::Auth::Types::TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.auth.refresh_token({ + clientId:'client_id', + clientSecret:'client_secret', + refreshToken:'refresh_token', + audience:'https://api.example.com', + grantType:'refresh_token', + scope:'scope' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**clientId:** `String` + +
+
+ +
+
+ +**clientSecret:** `String` + +
+
+ +
+
+ +**refreshToken:** `String` + +
+
+ +
+
+ +**audience:** `String` + +
+
+ +
+
+ +**grantType:** `String` + +
+
+ +
+
+ +**scope:** `String` + +
+
+
+
+ + +
+
+
+ +## NestedNoAuth Api +
client.NestedNoAuth.Api.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nested_no_auth.api.get_something(); +``` +
+
+
+
+ + +
+
+
+ +## Nested Api +
client.Nested.Api.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nested.api.get_something(); +``` +
+
+
+
+ + +
+
+
+ +## Service +
client.Service.Post(EndpointParam) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.post(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**endpointParam:** `String` + +
+
+
+
+ + +
+
+
+ +## Simple +
client.Simple.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.simple.get_something(); +``` +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/oauth-client-credentials-with-variables/test/custom.test.rb b/seed/ruby-sdk-v2/oauth-client-credentials-with-variables/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/oauth-client-credentials-with-variables/test/custom.test.rb +++ b/seed/ruby-sdk-v2/oauth-client-credentials-with-variables/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/oauth-client-credentials/reference.md b/seed/ruby-sdk-v2/oauth-client-credentials/reference.md new file mode 100644 index 00000000000..e5cf1d0bdb8 --- /dev/null +++ b/seed/ruby-sdk-v2/oauth-client-credentials/reference.md @@ -0,0 +1,244 @@ +# Reference +## Auth +
client.Auth.GetTokenWithClientCredentials(request) -> Seed::Auth::Types::TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.auth.get_token_with_client_credentials({ + clientId:'my_oauth_app_123', + clientSecret:'sk_live_abcdef123456789', + audience:'https://api.example.com', + grantType:'client_credentials', + scope:'read:users' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**clientId:** `String` + +
+
+ +
+
+ +**clientSecret:** `String` + +
+
+ +
+
+ +**audience:** `String` + +
+
+ +
+
+ +**grantType:** `String` + +
+
+ +
+
+ +**scope:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Auth.RefreshToken(request) -> Seed::Auth::Types::TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.auth.refresh_token({ + clientId:'my_oauth_app_123', + clientSecret:'sk_live_abcdef123456789', + refreshToken:'refresh_token', + audience:'https://api.example.com', + grantType:'refresh_token', + scope:'read:users' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**clientId:** `String` + +
+
+ +
+
+ +**clientSecret:** `String` + +
+
+ +
+
+ +**refreshToken:** `String` + +
+
+ +
+
+ +**audience:** `String` + +
+
+ +
+
+ +**grantType:** `String` + +
+
+ +
+
+ +**scope:** `String` + +
+
+
+
+ + +
+
+
+ +## NestedNoAuth Api +
client.NestedNoAuth.Api.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nested_no_auth.api.get_something(); +``` +
+
+
+
+ + +
+
+
+ +## Nested Api +
client.Nested.Api.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.nested.api.get_something(); +``` +
+
+
+
+ + +
+
+
+ +## Simple +
client.Simple.GetSomething() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.simple.get_something(); +``` +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/oauth-client-credentials/test/custom.test.rb b/seed/ruby-sdk-v2/oauth-client-credentials/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/oauth-client-credentials/test/custom.test.rb +++ b/seed/ruby-sdk-v2/oauth-client-credentials/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/object/reference.md b/seed/ruby-sdk-v2/object/reference.md new file mode 100644 index 00000000000..4a938e09d06 --- /dev/null +++ b/seed/ruby-sdk-v2/object/reference.md @@ -0,0 +1 @@ +# Reference \ No newline at end of file diff --git a/seed/ruby-sdk-v2/object/test/custom.test.rb b/seed/ruby-sdk-v2/object/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/object/test/custom.test.rb +++ b/seed/ruby-sdk-v2/object/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/objects-with-imports/reference.md b/seed/ruby-sdk-v2/objects-with-imports/reference.md new file mode 100644 index 00000000000..4a938e09d06 --- /dev/null +++ b/seed/ruby-sdk-v2/objects-with-imports/reference.md @@ -0,0 +1 @@ +# Reference \ No newline at end of file diff --git a/seed/ruby-sdk-v2/objects-with-imports/test/custom.test.rb b/seed/ruby-sdk-v2/objects-with-imports/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/objects-with-imports/test/custom.test.rb +++ b/seed/ruby-sdk-v2/objects-with-imports/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/optional/reference.md b/seed/ruby-sdk-v2/optional/reference.md new file mode 100644 index 00000000000..823c96c79e6 --- /dev/null +++ b/seed/ruby-sdk-v2/optional/reference.md @@ -0,0 +1,41 @@ +# Reference +## Optional +
client.Optional.SendOptionalBody(request) -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.optional.send_optional_body({}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Internal::Types::Hash[String, Internal::Types::Hash[String, Object]]` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/optional/test/custom.test.rb b/seed/ruby-sdk-v2/optional/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/optional/test/custom.test.rb +++ b/seed/ruby-sdk-v2/optional/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/package-yml/reference.md b/seed/ruby-sdk-v2/package-yml/reference.md new file mode 100644 index 00000000000..ce9ee7708b7 --- /dev/null +++ b/seed/ruby-sdk-v2/package-yml/reference.md @@ -0,0 +1,100 @@ +# Reference +
client.Echo(Id, request) -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.echo({ + name:'Hello world!', + size:20 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` + +
+
+ +
+
+ +**request:** `Seed::Types::EchoRequest` + +
+
+
+
+ + +
+
+
+ +## Service +
client.Service.Nop(Id, NestedId) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.nop(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` + +
+
+ +
+
+ +**nestedId:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/package-yml/test/custom.test.rb b/seed/ruby-sdk-v2/package-yml/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/package-yml/test/custom.test.rb +++ b/seed/ruby-sdk-v2/package-yml/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/pagination-custom/reference.md b/seed/ruby-sdk-v2/pagination-custom/reference.md new file mode 100644 index 00000000000..40152a26119 --- /dev/null +++ b/seed/ruby-sdk-v2/pagination-custom/reference.md @@ -0,0 +1,46 @@ +# Reference +## Users +
client.Users.ListUsernamesCustom() -> Seed::Types::UsernameCursor +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.users.list_usernames_custom({ + startingAfter:'starting_after' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**startingAfter:** `String` + +The cursor used for pagination in order to fetch +the next page of results. + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/pagination-custom/test/custom.test.rb b/seed/ruby-sdk-v2/pagination-custom/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/pagination-custom/test/custom.test.rb +++ b/seed/ruby-sdk-v2/pagination-custom/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/pagination/reference.md b/seed/ruby-sdk-v2/pagination/reference.md new file mode 100644 index 00000000000..ff34f356764 --- /dev/null +++ b/seed/ruby-sdk-v2/pagination/reference.md @@ -0,0 +1,1316 @@ +# Reference +## Conversations +
client.Complex.Search(Index, request) -> Seed::Complex::Types::PaginatedConversationResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.complex.search({ + pagination:{ + per_page:1, + starting_after:'starting_after' + } +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**index:** `String` + +
+
+ +
+
+ +**request:** `Seed::Complex::Types::SearchRequest` + +
+
+
+
+ + +
+
+
+ +## InlineUsers InlineUsers +
client.InlineUsers.InlineUsers.ListWithCursorPagination() -> Seed::InlineUsers::InlineUsers::Types::ListUsersPaginationResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.inline_users.inline_users.list_with_cursor_pagination({ + page:1, + perPage:1, + startingAfter:'starting_after' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page:** `Integer` — Defaults to first page + +
+
+ +
+
+ +**perPage:** `Integer` — Defaults to per page + +
+
+ +
+
+ +**order:** `Seed::InlineUsers::InlineUsers::Types::Order` + +
+
+ +
+
+ +**startingAfter:** `String` + +The cursor used for pagination in order to fetch +the next page of results. + +
+
+
+
+ + +
+
+
+ +
client.InlineUsers.InlineUsers.ListWithMixedTypeCursorPagination() -> Seed::InlineUsers::InlineUsers::Types::ListUsersMixedTypePaginationResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.inline_users.inline_users.list_with_mixed_type_cursor_pagination({ + cursor:'cursor' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `String` + +
+
+
+
+ + +
+
+
+ +
client.InlineUsers.InlineUsers.ListWithBodyCursorPagination(request) -> Seed::InlineUsers::InlineUsers::Types::ListUsersPaginationResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.inline_users.inline_users.list_with_mixed_type_cursor_pagination({}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**pagination:** `Seed::InlineUsers::InlineUsers::Types::WithCursor` + +The object that contains the cursor used for pagination +in order to fetch the next page of results. + +
+
+
+
+ + +
+
+
+ +
client.InlineUsers.InlineUsers.ListWithOffsetPagination() -> Seed::InlineUsers::InlineUsers::Types::ListUsersPaginationResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.inline_users.inline_users.list_with_cursor_pagination({ + page:1, + perPage:1, + startingAfter:'starting_after' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page:** `Integer` — Defaults to first page + +
+
+ +
+
+ +**perPage:** `Integer` — Defaults to per page + +
+
+ +
+
+ +**order:** `Seed::InlineUsers::InlineUsers::Types::Order` + +
+
+ +
+
+ +**startingAfter:** `String` + +The cursor used for pagination in order to fetch +the next page of results. + +
+
+
+
+ + +
+
+
+ +
client.InlineUsers.InlineUsers.ListWithDoubleOffsetPagination() -> Seed::InlineUsers::InlineUsers::Types::ListUsersPaginationResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.inline_users.inline_users.list_with_cursor_pagination({ + page:1.1, + perPage:1.1, + startingAfter:'starting_after' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page:** `Integer` — Defaults to first page + +
+
+ +
+
+ +**perPage:** `Integer` — Defaults to per page + +
+
+ +
+
+ +**order:** `Seed::InlineUsers::InlineUsers::Types::Order` + +
+
+ +
+
+ +**startingAfter:** `String` + +The cursor used for pagination in order to fetch +the next page of results. + +
+
+
+
+ + +
+
+
+ +
client.InlineUsers.InlineUsers.ListWithBodyOffsetPagination(request) -> Seed::InlineUsers::InlineUsers::Types::ListUsersPaginationResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.inline_users.inline_users.list_with_mixed_type_cursor_pagination({}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**pagination:** `Seed::InlineUsers::InlineUsers::Types::WithPage` + +The object that contains the offset used for pagination +in order to fetch the next page of results. + +
+
+
+
+ + +
+
+
+ +
client.InlineUsers.InlineUsers.ListWithOffsetStepPagination() -> Seed::InlineUsers::InlineUsers::Types::ListUsersPaginationResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.inline_users.inline_users.list_with_cursor_pagination({ + page:1 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page:** `Integer` — Defaults to first page + +
+
+ +
+
+ +**limit:** `Integer` + +The maximum number of elements to return. +This is also used as the step size in this +paginated endpoint. + +
+
+ +
+
+ +**order:** `Seed::InlineUsers::InlineUsers::Types::Order` + +
+
+
+
+ + +
+
+
+ +
client.InlineUsers.InlineUsers.ListWithOffsetPaginationHasNextPage() -> Seed::InlineUsers::InlineUsers::Types::ListUsersPaginationResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.inline_users.inline_users.list_with_cursor_pagination({ + page:1 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page:** `Integer` — Defaults to first page + +
+
+ +
+
+ +**limit:** `Integer` + +The maximum number of elements to return. +This is also used as the step size in this +paginated endpoint. + +
+
+ +
+
+ +**order:** `Seed::InlineUsers::InlineUsers::Types::Order` + +
+
+
+
+ + +
+
+
+ +
client.InlineUsers.InlineUsers.ListWithExtendedResults() -> Seed::InlineUsers::InlineUsers::Types::ListUsersExtendedResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.inline_users.inline_users.list_with_cursor_pagination({}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `String` + +
+
+
+
+ + +
+
+
+ +
client.InlineUsers.InlineUsers.ListWithExtendedResultsAndOptionalData() -> Seed::InlineUsers::InlineUsers::Types::ListUsersExtendedOptionalListResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.inline_users.inline_users.list_with_cursor_pagination({}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `String` + +
+
+
+
+ + +
+
+
+ +
client.InlineUsers.InlineUsers.ListUsernames() -> Seed::Types::UsernameCursor +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.inline_users.inline_users.list_with_cursor_pagination({ + startingAfter:'starting_after' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**startingAfter:** `String` + +The cursor used for pagination in order to fetch +the next page of results. + +
+
+
+
+ + +
+
+
+ +
client.InlineUsers.InlineUsers.ListWithGlobalConfig() -> Seed::InlineUsers::InlineUsers::Types::UsernameContainer +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.inline_users.inline_users.list_with_cursor_pagination({}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**offset:** `Integer` + +
+
+
+
+ + +
+
+
+ +## Users +
client.Users.ListWithCursorPagination() -> Seed::Users::Types::ListUsersPaginationResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.users.list_with_cursor_pagination({ + page:1, + perPage:1, + startingAfter:'starting_after' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page:** `Integer` — Defaults to first page + +
+
+ +
+
+ +**perPage:** `Integer` — Defaults to per page + +
+
+ +
+
+ +**order:** `Seed::Users::Types::Order` + +
+
+ +
+
+ +**startingAfter:** `String` + +The cursor used for pagination in order to fetch +the next page of results. + +
+
+
+
+ + +
+
+
+ +
client.Users.ListWithMixedTypeCursorPagination() -> Seed::Users::Types::ListUsersMixedTypePaginationResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.users.list_with_mixed_type_cursor_pagination({ + cursor:'cursor' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Users.ListWithBodyCursorPagination(request) -> Seed::Users::Types::ListUsersPaginationResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.users.list_with_mixed_type_cursor_pagination({}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**pagination:** `Seed::Users::Types::WithCursor` + +The object that contains the cursor used for pagination +in order to fetch the next page of results. + +
+
+
+
+ + +
+
+
+ +
client.Users.ListWithOffsetPagination() -> Seed::Users::Types::ListUsersPaginationResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.users.list_with_cursor_pagination({ + page:1, + perPage:1, + startingAfter:'starting_after' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page:** `Integer` — Defaults to first page + +
+
+ +
+
+ +**perPage:** `Integer` — Defaults to per page + +
+
+ +
+
+ +**order:** `Seed::Users::Types::Order` + +
+
+ +
+
+ +**startingAfter:** `String` + +The cursor used for pagination in order to fetch +the next page of results. + +
+
+
+
+ + +
+
+
+ +
client.Users.ListWithDoubleOffsetPagination() -> Seed::Users::Types::ListUsersPaginationResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.users.list_with_cursor_pagination({ + page:1.1, + perPage:1.1, + startingAfter:'starting_after' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page:** `Integer` — Defaults to first page + +
+
+ +
+
+ +**perPage:** `Integer` — Defaults to per page + +
+
+ +
+
+ +**order:** `Seed::Users::Types::Order` + +
+
+ +
+
+ +**startingAfter:** `String` + +The cursor used for pagination in order to fetch +the next page of results. + +
+
+
+
+ + +
+
+
+ +
client.Users.ListWithBodyOffsetPagination(request) -> Seed::Users::Types::ListUsersPaginationResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.users.list_with_mixed_type_cursor_pagination({}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**pagination:** `Seed::Users::Types::WithPage` + +The object that contains the offset used for pagination +in order to fetch the next page of results. + +
+
+
+
+ + +
+
+
+ +
client.Users.ListWithOffsetStepPagination() -> Seed::Users::Types::ListUsersPaginationResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.users.list_with_cursor_pagination({ + page:1 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page:** `Integer` — Defaults to first page + +
+
+ +
+
+ +**limit:** `Integer` + +The maximum number of elements to return. +This is also used as the step size in this +paginated endpoint. + +
+
+ +
+
+ +**order:** `Seed::Users::Types::Order` + +
+
+
+
+ + +
+
+
+ +
client.Users.ListWithOffsetPaginationHasNextPage() -> Seed::Users::Types::ListUsersPaginationResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.users.list_with_cursor_pagination({ + page:1 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page:** `Integer` — Defaults to first page + +
+
+ +
+
+ +**limit:** `Integer` + +The maximum number of elements to return. +This is also used as the step size in this +paginated endpoint. + +
+
+ +
+
+ +**order:** `Seed::Users::Types::Order` + +
+
+
+
+ + +
+
+
+ +
client.Users.ListWithExtendedResults() -> Seed::Users::Types::ListUsersExtendedResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.users.list_with_cursor_pagination({}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Users.ListWithExtendedResultsAndOptionalData() -> Seed::Users::Types::ListUsersExtendedOptionalListResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.users.list_with_cursor_pagination({}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Users.ListUsernames() -> Seed::Types::UsernameCursor +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.users.list_with_cursor_pagination({ + startingAfter:'starting_after' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**startingAfter:** `String` + +The cursor used for pagination in order to fetch +the next page of results. + +
+
+
+
+ + +
+
+
+ +
client.Users.ListWithGlobalConfig() -> Seed::Users::Types::UsernameContainer +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.users.list_with_cursor_pagination({}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**offset:** `Integer` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/pagination/test/custom.test.rb b/seed/ruby-sdk-v2/pagination/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/pagination/test/custom.test.rb +++ b/seed/ruby-sdk-v2/pagination/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/path-parameters/reference.md b/seed/ruby-sdk-v2/path-parameters/reference.md new file mode 100644 index 00000000000..bad19a4bf37 --- /dev/null +++ b/seed/ruby-sdk-v2/path-parameters/reference.md @@ -0,0 +1,386 @@ +# Reference +## Organizations +
client.Organizations.GetOrganization(TenantId, OrganizationId) -> Seed::Organizations::Types::Organization +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.organizations.get_organization(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**tenantId:** `String` + +
+
+ +
+
+ +**organizationId:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Organizations.GetOrganizationUser(TenantId, OrganizationId, UserId) -> Seed::User::Types::User +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.organizations.get_organization_user({ + organizationId:'organization_id', + userId:'user_id' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**tenantId:** `String` + +
+
+ +
+
+ +**organizationId:** `String` + +
+
+ +
+
+ +**userId:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Organizations.SearchOrganizations(TenantId, OrganizationId) -> Internal::Types::Array[Seed::Organizations::Types::Organization] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.organizations.search_organizations({ + organizationId:'organization_id', + limit:1 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**tenantId:** `String` + +
+
+ +
+
+ +**organizationId:** `String` + +
+
+ +
+
+ +**limit:** `Integer` + +
+
+
+
+ + +
+
+
+ +## User +
client.User.GetUser(TenantId, UserId) -> Seed::User::Types::User +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.user.get_user({ + userId:'user_id' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**tenantId:** `String` + +
+
+ +
+
+ +**userId:** `String` + +
+
+
+
+ + +
+
+
+ +
client.User.CreateUser(TenantId, request) -> Seed::User::Types::User +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.user.create_user({ + name:'name', + tags:['tags', 'tags'] +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**tenantId:** `String` + +
+
+ +
+
+ +**request:** `Seed::User::Types::User` + +
+
+
+
+ + +
+
+
+ +
client.User.UpdateUser(TenantId, UserId, request) -> Seed::User::Types::User +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.user.update_user({ + userId:'user_id' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**tenantId:** `String` + +
+
+ +
+
+ +**userId:** `String` + +
+
+ +
+
+ +**request:** `Seed::User::Types::User` + +
+
+
+
+ + +
+
+
+ +
client.User.SearchUsers(TenantId, UserId) -> Internal::Types::Array[Seed::User::Types::User] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.user.search_users({ + userId:'user_id', + limit:1 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**tenantId:** `String` + +
+
+ +
+
+ +**userId:** `String` + +
+
+ +
+
+ +**limit:** `Integer` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/path-parameters/test/custom.test.rb b/seed/ruby-sdk-v2/path-parameters/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/path-parameters/test/custom.test.rb +++ b/seed/ruby-sdk-v2/path-parameters/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/plain-text/reference.md b/seed/ruby-sdk-v2/plain-text/reference.md new file mode 100644 index 00000000000..91a368b7daa --- /dev/null +++ b/seed/ruby-sdk-v2/plain-text/reference.md @@ -0,0 +1,26 @@ +# Reference +## Service +
client.Service.GetText() -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get_text(); +``` +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/plain-text/test/custom.test.rb b/seed/ruby-sdk-v2/plain-text/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/plain-text/test/custom.test.rb +++ b/seed/ruby-sdk-v2/plain-text/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/property-access/reference.md b/seed/ruby-sdk-v2/property-access/reference.md new file mode 100644 index 00000000000..74d08005938 --- /dev/null +++ b/seed/ruby-sdk-v2/property-access/reference.md @@ -0,0 +1,51 @@ +# Reference +
client.CreateUser(request) -> Seed::Types::User +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.create_user({ + id:'id', + email:'email', + password:'password', + profile:{ + name:'name', + verification:{ + verified:'verified' + }, + ssn:'ssn' + } +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Types::User` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/property-access/test/custom.test.rb b/seed/ruby-sdk-v2/property-access/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/property-access/test/custom.test.rb +++ b/seed/ruby-sdk-v2/property-access/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/public-object/reference.md b/seed/ruby-sdk-v2/public-object/reference.md new file mode 100644 index 00000000000..aecd4cd2bbc --- /dev/null +++ b/seed/ruby-sdk-v2/public-object/reference.md @@ -0,0 +1,2 @@ +# Reference +## Service \ No newline at end of file diff --git a/seed/ruby-sdk-v2/public-object/test/custom.test.rb b/seed/ruby-sdk-v2/public-object/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/public-object/test/custom.test.rb +++ b/seed/ruby-sdk-v2/public-object/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/query-parameters-openapi-as-objects/reference.md b/seed/ruby-sdk-v2/query-parameters-openapi-as-objects/reference.md new file mode 100644 index 00000000000..54995a5a658 --- /dev/null +++ b/seed/ruby-sdk-v2/query-parameters-openapi-as-objects/reference.md @@ -0,0 +1,186 @@ +# Reference +
client.Search() -> Seed::Types::SearchResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.search({ + limit:1, + id:'id', + date:'date', + deadline:'2024-01-15T09:30:00Z', + bytes:'bytes', + user:{ + name:'name', + tags:['tags', 'tags'] + }, + optionalDeadline:'2024-01-15T09:30:00Z', + keyValue:{ + keyValue:'keyValue' + }, + optionalString:'optionalString', + nestedUser:{ + name:'name', + user:{ + name:'name', + tags:['tags', 'tags'] + } + }, + optionalUser:{ + name:'name', + tags:['tags', 'tags'] + } +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**limit:** `Integer` + +
+
+ +
+
+ +**id:** `String` + +
+
+ +
+
+ +**date:** `String` + +
+
+ +
+
+ +**deadline:** `String` + +
+
+ +
+
+ +**bytes:** `String` + +
+
+ +
+
+ +**user:** `Seed::Types::User` + +
+
+ +
+
+ +**userList:** `Seed::Types::User` + +
+
+ +
+
+ +**optionalDeadline:** `String` + +
+
+ +
+
+ +**keyValue:** `Internal::Types::Hash[String, String]` + +
+
+ +
+
+ +**optionalString:** `String` + +
+
+ +
+
+ +**nestedUser:** `Seed::Types::NestedUser` + +
+
+ +
+
+ +**optionalUser:** `Seed::Types::User` + +
+
+ +
+
+ +**excludeUser:** `Seed::Types::User` + +
+
+ +
+
+ +**filter:** `String` + +
+
+ +
+
+ +**neighbor:** `Seed::Types::SearchRequestNeighbor` + +
+
+ +
+
+ +**neighborRequired:** `Seed::Types::SearchRequestNeighborRequired` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/query-parameters-openapi-as-objects/test/custom.test.rb b/seed/ruby-sdk-v2/query-parameters-openapi-as-objects/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/query-parameters-openapi-as-objects/test/custom.test.rb +++ b/seed/ruby-sdk-v2/query-parameters-openapi-as-objects/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/query-parameters-openapi/reference.md b/seed/ruby-sdk-v2/query-parameters-openapi/reference.md new file mode 100644 index 00000000000..32321981643 --- /dev/null +++ b/seed/ruby-sdk-v2/query-parameters-openapi/reference.md @@ -0,0 +1,190 @@ +# Reference +
client.Search() -> Seed::Types::SearchResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.search({ + limit:1, + id:'id', + date:'date', + deadline:'2024-01-15T09:30:00Z', + bytes:'bytes', + user:{ + name:'name', + tags:['tags', 'tags'] + }, + optionalDeadline:'2024-01-15T09:30:00Z', + keyValue:{ + keyValue:'keyValue' + }, + optionalString:'optionalString', + nestedUser:{ + name:'name', + user:{ + name:'name', + tags:['tags', 'tags'] + } + }, + optionalUser:{ + name:'name', + tags:['tags', 'tags'] + }, + neighbor:{ + name:'name', + tags:['tags', 'tags'] + } +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**limit:** `Integer` + +
+
+ +
+
+ +**id:** `String` + +
+
+ +
+
+ +**date:** `String` + +
+
+ +
+
+ +**deadline:** `String` + +
+
+ +
+
+ +**bytes:** `String` + +
+
+ +
+
+ +**user:** `Seed::Types::User` + +
+
+ +
+
+ +**userList:** `Seed::Types::User` + +
+
+ +
+
+ +**optionalDeadline:** `String` + +
+
+ +
+
+ +**keyValue:** `Internal::Types::Hash[String, String]` + +
+
+ +
+
+ +**optionalString:** `String` + +
+
+ +
+
+ +**nestedUser:** `Seed::Types::NestedUser` + +
+
+ +
+
+ +**optionalUser:** `Seed::Types::User` + +
+
+ +
+
+ +**excludeUser:** `Seed::Types::User` + +
+
+ +
+
+ +**filter:** `String` + +
+
+ +
+
+ +**neighbor:** `Seed::Types::User` + +
+
+ +
+
+ +**neighborRequired:** `Seed::Types::SearchRequestNeighborRequired` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/query-parameters-openapi/test/custom.test.rb b/seed/ruby-sdk-v2/query-parameters-openapi/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/query-parameters-openapi/test/custom.test.rb +++ b/seed/ruby-sdk-v2/query-parameters-openapi/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/query-parameters/reference.md b/seed/ruby-sdk-v2/query-parameters/reference.md new file mode 100644 index 00000000000..3da7bbaabd4 --- /dev/null +++ b/seed/ruby-sdk-v2/query-parameters/reference.md @@ -0,0 +1,178 @@ +# Reference +## User +
client.User.GetUsername() -> Seed::User::Types::User +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.user.get_username({ + limit:1, + id:'d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', + date:'2023-01-15', + deadline:'2024-01-15T09:30:00Z', + bytes:'SGVsbG8gd29ybGQh', + user:{ + name:'name', + tags:['tags', 'tags'] + }, + userList:[{ + name:'name', + tags:['tags', 'tags'] + }, { + name:'name', + tags:['tags', 'tags'] + }], + optionalDeadline:'2024-01-15T09:30:00Z', + keyValue:{ + keyValue:'keyValue' + }, + optionalString:'optionalString', + nestedUser:{ + name:'name', + user:{ + name:'name', + tags:['tags', 'tags'] + } + }, + optionalUser:{ + name:'name', + tags:['tags', 'tags'] + } +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**limit:** `Integer` + +
+
+ +
+
+ +**id:** `String` + +
+
+ +
+
+ +**date:** `String` + +
+
+ +
+
+ +**deadline:** `String` + +
+
+ +
+
+ +**bytes:** `String` + +
+
+ +
+
+ +**user:** `Seed::User::Types::User` + +
+
+ +
+
+ +**userList:** `Internal::Types::Array[Seed::User::Types::User]` + +
+
+ +
+
+ +**optionalDeadline:** `String` + +
+
+ +
+
+ +**keyValue:** `Internal::Types::Hash[String, String]` + +
+
+ +
+
+ +**optionalString:** `String` + +
+
+ +
+
+ +**nestedUser:** `Seed::User::Types::NestedUser` + +
+
+ +
+
+ +**optionalUser:** `Seed::User::Types::User` + +
+
+ +
+
+ +**excludeUser:** `Seed::User::Types::User` + +
+
+ +
+
+ +**filter:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/query-parameters/test/custom.test.rb b/seed/ruby-sdk-v2/query-parameters/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/query-parameters/test/custom.test.rb +++ b/seed/ruby-sdk-v2/query-parameters/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/request-parameters/reference.md b/seed/ruby-sdk-v2/request-parameters/reference.md new file mode 100644 index 00000000000..9d32778ed90 --- /dev/null +++ b/seed/ruby-sdk-v2/request-parameters/reference.md @@ -0,0 +1,315 @@ +# Reference +## User +
client.User.CreateUsername(request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.user.create_username({ + tags:['tags', 'tags'], + username:'username', + password:'password', + name:'test' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**tags:** `Internal::Types::Array[String]` + +
+
+ +
+
+ +**username:** `String` + +
+
+ +
+
+ +**password:** `String` + +
+
+ +
+
+ +**name:** `String` + +
+
+
+
+ + +
+
+
+ +
client.User.CreateUsernameWithReferencedType(request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.user.create_username_with_referenced_type({ + tags:['tags', 'tags'] +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**tags:** `Internal::Types::Array[String]` + +
+
+ +
+
+ +**request:** `Seed::User::Types::CreateUsernameBody` + +
+
+
+
+ + +
+
+
+ +
client.User.GetUsername() -> Seed::User::Types::User +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.user.get_username({ + limit:1, + id:'d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', + date:'2023-01-15', + deadline:'2024-01-15T09:30:00Z', + bytes:'SGVsbG8gd29ybGQh', + user:{ + name:'name', + tags:['tags', 'tags'] + }, + userList:[{ + name:'name', + tags:['tags', 'tags'] + }, { + name:'name', + tags:['tags', 'tags'] + }], + optionalDeadline:'2024-01-15T09:30:00Z', + keyValue:{ + keyValue:'keyValue' + }, + optionalString:'optionalString', + nestedUser:{ + name:'name', + user:{ + name:'name', + tags:['tags', 'tags'] + } + }, + optionalUser:{ + name:'name', + tags:['tags', 'tags'] + }, + longParam:1000000, + bigIntParam:'1000000' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**limit:** `Integer` + +
+
+ +
+
+ +**id:** `String` + +
+
+ +
+
+ +**date:** `String` + +
+
+ +
+
+ +**deadline:** `String` + +
+
+ +
+
+ +**bytes:** `String` + +
+
+ +
+
+ +**user:** `Seed::User::Types::User` + +
+
+ +
+
+ +**userList:** `Internal::Types::Array[Seed::User::Types::User]` + +
+
+ +
+
+ +**optionalDeadline:** `String` + +
+
+ +
+
+ +**keyValue:** `Internal::Types::Hash[String, String]` + +
+
+ +
+
+ +**optionalString:** `String` + +
+
+ +
+
+ +**nestedUser:** `Seed::User::Types::NestedUser` + +
+
+ +
+
+ +**optionalUser:** `Seed::User::Types::User` + +
+
+ +
+
+ +**excludeUser:** `Seed::User::Types::User` + +
+
+ +
+
+ +**filter:** `String` + +
+
+ +
+
+ +**longParam:** `Integer` + +
+
+ +
+
+ +**bigIntParam:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/request-parameters/test/custom.test.rb b/seed/ruby-sdk-v2/request-parameters/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/request-parameters/test/custom.test.rb +++ b/seed/ruby-sdk-v2/request-parameters/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/reserved-keywords/reference.md b/seed/ruby-sdk-v2/reserved-keywords/reference.md new file mode 100644 index 00000000000..33c5b7cf584 --- /dev/null +++ b/seed/ruby-sdk-v2/reserved-keywords/reference.md @@ -0,0 +1,43 @@ +# Reference +## Package +
client.Package.Test() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.package.test({ + for_:'for' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**for_:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/reserved-keywords/test/custom.test.rb b/seed/ruby-sdk-v2/reserved-keywords/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/reserved-keywords/test/custom.test.rb +++ b/seed/ruby-sdk-v2/reserved-keywords/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/response-property/reference.md b/seed/ruby-sdk-v2/response-property/reference.md new file mode 100644 index 00000000000..0247f6aac37 --- /dev/null +++ b/seed/ruby-sdk-v2/response-property/reference.md @@ -0,0 +1,281 @@ +# Reference +## Service +
client.Service.GetMovie(request) -> Seed::Service::Types::Response +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get_optional_movie_docs(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Service.GetMovieDocs(request) -> Seed::Service::Types::Response +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get_optional_movie_docs(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Service.GetMovieName(request) -> Seed::Types::StringResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get_optional_movie_docs(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Service.GetMovieMetadata(request) -> Seed::Service::Types::Response +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get_optional_movie_docs(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Service.GetOptionalMovie(request) -> Seed::Service::Types::Response +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get_optional_movie_docs(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Service.GetOptionalMovieDocs(request) -> Seed::Service::Types::WithDocs +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get_optional_movie_docs(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Service.GetOptionalMovieName(request) -> Seed::Types::StringResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get_optional_movie_docs(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/response-property/test/custom.test.rb b/seed/ruby-sdk-v2/response-property/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/response-property/test/custom.test.rb +++ b/seed/ruby-sdk-v2/response-property/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/ruby-reserved-word-properties/reference.md b/seed/ruby-sdk-v2/ruby-reserved-word-properties/reference.md new file mode 100644 index 00000000000..189ec9088d4 --- /dev/null +++ b/seed/ruby-sdk-v2/ruby-reserved-word-properties/reference.md @@ -0,0 +1,26 @@ +# Reference +## Service +
client.Service.Get() -> Seed::Service::Types::Foo +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.get(); +``` +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/ruby-reserved-word-properties/test/custom.test.rb b/seed/ruby-sdk-v2/ruby-reserved-word-properties/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/ruby-reserved-word-properties/test/custom.test.rb +++ b/seed/ruby-sdk-v2/ruby-reserved-word-properties/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/server-sent-event-examples/reference.md b/seed/ruby-sdk-v2/server-sent-event-examples/reference.md new file mode 100644 index 00000000000..642d531d350 --- /dev/null +++ b/seed/ruby-sdk-v2/server-sent-event-examples/reference.md @@ -0,0 +1,43 @@ +# Reference +## Completions +
client.Completions.Stream(request) -> Seed::Completions::Types::StreamedCompletion +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.completions.stream({ + query:'foo' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**query:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/server-sent-event-examples/test/custom.test.rb b/seed/ruby-sdk-v2/server-sent-event-examples/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/server-sent-event-examples/test/custom.test.rb +++ b/seed/ruby-sdk-v2/server-sent-event-examples/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/server-sent-events/reference.md b/seed/ruby-sdk-v2/server-sent-events/reference.md new file mode 100644 index 00000000000..d9852f8f279 --- /dev/null +++ b/seed/ruby-sdk-v2/server-sent-events/reference.md @@ -0,0 +1,43 @@ +# Reference +## Completions +
client.Completions.Stream(request) -> Seed::Completions::Types::StreamedCompletion +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.completions.stream({ + query:'query' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**query:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/server-sent-events/test/custom.test.rb b/seed/ruby-sdk-v2/server-sent-events/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/server-sent-events/test/custom.test.rb +++ b/seed/ruby-sdk-v2/server-sent-events/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/simple-api/reference.md b/seed/ruby-sdk-v2/simple-api/reference.md new file mode 100644 index 00000000000..b76c09b5712 --- /dev/null +++ b/seed/ruby-sdk-v2/simple-api/reference.md @@ -0,0 +1,41 @@ +# Reference +## User +
client.User.Get(Id) -> Seed::User::Types::User +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.user.get(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/simple-api/test/custom.test.rb b/seed/ruby-sdk-v2/simple-api/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/simple-api/test/custom.test.rb +++ b/seed/ruby-sdk-v2/simple-api/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/simple-fhir/reference.md b/seed/ruby-sdk-v2/simple-fhir/reference.md new file mode 100644 index 00000000000..8329b24eb76 --- /dev/null +++ b/seed/ruby-sdk-v2/simple-fhir/reference.md @@ -0,0 +1,40 @@ +# Reference +
client.GetAccount(AccountId) -> Seed::Types::Account +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.get_account(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**accountId:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/simple-fhir/test/custom.test.rb b/seed/ruby-sdk-v2/simple-fhir/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/simple-fhir/test/custom.test.rb +++ b/seed/ruby-sdk-v2/simple-fhir/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/single-url-environment-default/reference.md b/seed/ruby-sdk-v2/single-url-environment-default/reference.md new file mode 100644 index 00000000000..32c15caa385 --- /dev/null +++ b/seed/ruby-sdk-v2/single-url-environment-default/reference.md @@ -0,0 +1,26 @@ +# Reference +## Dummy +
client.Dummy.GetDummy() -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.dummy.get_dummy(); +``` +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/single-url-environment-default/test/custom.test.rb b/seed/ruby-sdk-v2/single-url-environment-default/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/single-url-environment-default/test/custom.test.rb +++ b/seed/ruby-sdk-v2/single-url-environment-default/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/single-url-environment-no-default/reference.md b/seed/ruby-sdk-v2/single-url-environment-no-default/reference.md new file mode 100644 index 00000000000..32c15caa385 --- /dev/null +++ b/seed/ruby-sdk-v2/single-url-environment-no-default/reference.md @@ -0,0 +1,26 @@ +# Reference +## Dummy +
client.Dummy.GetDummy() -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.dummy.get_dummy(); +``` +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/single-url-environment-no-default/test/custom.test.rb b/seed/ruby-sdk-v2/single-url-environment-no-default/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/single-url-environment-no-default/test/custom.test.rb +++ b/seed/ruby-sdk-v2/single-url-environment-no-default/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/streaming-parameter/reference.md b/seed/ruby-sdk-v2/streaming-parameter/reference.md new file mode 100644 index 00000000000..6680eb39c3b --- /dev/null +++ b/seed/ruby-sdk-v2/streaming-parameter/reference.md @@ -0,0 +1,52 @@ +# Reference +## Dummy +
client.Dummy.Generate(request) -> Seed::Dummy::Types::StreamResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.dummy.generate({ + stream:false, + numEvents:5 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**stream:** `Internal::Types::Boolean` + +
+
+ +
+
+ +**numEvents:** `Integer` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/streaming-parameter/test/custom.test.rb b/seed/ruby-sdk-v2/streaming-parameter/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/streaming-parameter/test/custom.test.rb +++ b/seed/ruby-sdk-v2/streaming-parameter/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/streaming/reference.md b/seed/ruby-sdk-v2/streaming/reference.md new file mode 100644 index 00000000000..bb904d50113 --- /dev/null +++ b/seed/ruby-sdk-v2/streaming/reference.md @@ -0,0 +1,103 @@ +# Reference +## Dummy +
client.Dummy.GenerateStream(request) -> Seed::Dummy::Types::StreamResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.dummy.generate_stream({ + stream:true, + numEvents:1 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**stream:** `Internal::Types::Boolean` + +
+
+ +
+
+ +**numEvents:** `Integer` + +
+
+
+
+ + +
+
+
+ +
client.Dummy.Generate(request) -> Seed::Dummy::Types::StreamResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.dummy.generate({ + stream:false, + numEvents:5 +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**stream:** `Internal::Types::Boolean` + +
+
+ +
+
+ +**numEvents:** `Integer` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/streaming/test/custom.test.rb b/seed/ruby-sdk-v2/streaming/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/streaming/test/custom.test.rb +++ b/seed/ruby-sdk-v2/streaming/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/trace/reference.md b/seed/ruby-sdk-v2/trace/reference.md new file mode 100644 index 00000000000..0bafffba969 --- /dev/null +++ b/seed/ruby-sdk-v2/trace/reference.md @@ -0,0 +1,1992 @@ +# Reference +## V2 +
client.V2.Test() -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.v_2.test(); +``` +
+
+
+
+ + +
+
+
+ +## Admin +
client.Admin.UpdateTestSubmissionStatus(SubmissionId, request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.admin.update_test_submission_status(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `String` + +
+
+ +
+
+ +**request:** `Seed::Submission::Types::TestSubmissionStatus` + +
+
+
+
+ + +
+
+
+ +
client.Admin.SendTestSubmissionUpdate(SubmissionId, request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.admin.send_test_submission_update({ + updateTime:'2024-01-15T09:30:00Z' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `String` + +
+
+ +
+
+ +**request:** `Seed::Submission::Types::TestSubmissionUpdate` + +
+
+
+
+ + +
+
+
+ +
client.Admin.UpdateWorkspaceSubmissionStatus(SubmissionId, request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.admin.update_workspace_submission_status(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `String` + +
+
+ +
+
+ +**request:** `Seed::Submission::Types::WorkspaceSubmissionStatus` + +
+
+
+
+ + +
+
+
+ +
client.Admin.SendWorkspaceSubmissionUpdate(SubmissionId, request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.admin.send_workspace_submission_update({ + updateTime:'2024-01-15T09:30:00Z' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `String` + +
+
+ +
+
+ +**request:** `Seed::Submission::Types::WorkspaceSubmissionUpdate` + +
+
+
+
+ + +
+
+
+ +
client.Admin.StoreTracedTestCase(SubmissionId, TestCaseId, request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.admin.store_traced_test_case({ + submissionId:'d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', + testCaseId:'testCaseId', + result:{ + result:{ + passed:true + }, + stdout:'stdout' + }, + traceResponses:[{ + submissionId:'d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', + lineNumber:1, + expressionLocation:{ + start:1, + offset:1 + }, + stack:{ + numStackFrames:1, + topStackFrame:{ + methodName:'methodName', + lineNumber:1, + scopes:[{ + variables:{} + }, { + variables:{} + }] + } + }, + stdout:'stdout' + }, { + submissionId:'d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', + lineNumber:1, + expressionLocation:{ + start:1, + offset:1 + }, + stack:{ + numStackFrames:1, + topStackFrame:{ + methodName:'methodName', + lineNumber:1, + scopes:[{ + variables:{} + }, { + variables:{} + }] + } + }, + stdout:'stdout' + }] +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `String` + +
+
+ +
+
+ +**testCaseId:** `String` + +
+
+ +
+
+ +**result:** `Seed::Submission::Types::TestCaseResultWithStdout` + +
+
+ +
+
+ +**traceResponses:** `Internal::Types::Array[Seed::Submission::Types::TraceResponse]` + +
+
+
+
+ + +
+
+
+ +
client.Admin.StoreTracedTestCaseV2(SubmissionId, TestCaseId, request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.admin.store_traced_test_case_v_2(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `String` + +
+
+ +
+
+ +**testCaseId:** `String` + +
+
+ +
+
+ +**request:** `Internal::Types::Array[Seed::Submission::Types::TraceResponseV2]` + +
+
+
+
+ + +
+
+
+ +
client.Admin.StoreTracedWorkspace(SubmissionId, request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.admin.store_traced_workspace({ + submissionId:'d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', + workspaceRunDetails:{ + exception:{ + exceptionType:'exceptionType', + exceptionMessage:'exceptionMessage', + exceptionStacktrace:'exceptionStacktrace' + }, + stdout:'stdout' + }, + traceResponses:[{ + submissionId:'d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', + lineNumber:1, + expressionLocation:{ + start:1, + offset:1 + }, + stack:{ + numStackFrames:1, + topStackFrame:{ + methodName:'methodName', + lineNumber:1, + scopes:[{ + variables:{} + }, { + variables:{} + }] + } + }, + stdout:'stdout' + }, { + submissionId:'d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', + lineNumber:1, + expressionLocation:{ + start:1, + offset:1 + }, + stack:{ + numStackFrames:1, + topStackFrame:{ + methodName:'methodName', + lineNumber:1, + scopes:[{ + variables:{} + }, { + variables:{} + }] + } + }, + stdout:'stdout' + }] +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `String` + +
+
+ +
+
+ +**workspaceRunDetails:** `Seed::Submission::Types::WorkspaceRunDetails` + +
+
+ +
+
+ +**traceResponses:** `Internal::Types::Array[Seed::Submission::Types::TraceResponse]` + +
+
+
+
+ + +
+
+
+ +
client.Admin.StoreTracedWorkspaceV2(SubmissionId, request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.admin.store_traced_workspace_v_2(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**submissionId:** `String` + +
+
+ +
+
+ +**request:** `Internal::Types::Array[Seed::Submission::Types::TraceResponseV2]` + +
+
+
+
+ + +
+
+
+ +## Homepage +
client.Homepage.GetHomepageProblems() -> Internal::Types::Array[String] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.homepage.get_homepage_problems(); +``` +
+
+
+
+ + +
+
+
+ +
client.Homepage.SetHomepageProblems(request) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.homepage.set_homepage_problems(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Internal::Types::Array[String]` + +
+
+
+
+ + +
+
+
+ +## Migration +
client.Migration.GetAttemptedMigrations() -> Internal::Types::Array[Seed::Migration::Types::Migration] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.migration.get_attempted_migrations({ + adminKeyHeader:'admin-key-header' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**adminKeyHeader:** `String` + +
+
+
+
+ + +
+
+
+ +## Playlist +
client.Playlist.CreatePlaylist(ServiceParam, request) -> Seed::Playlist::Types::Playlist +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Create a new playlist +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.playlist.create_playlist({ + serviceParam:1, + datetime:'2024-01-15T09:30:00Z', + optionalDatetime:'2024-01-15T09:30:00Z' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `Integer` + +
+
+ +
+
+ +**datetime:** `String` + +
+
+ +
+
+ +**optionalDatetime:** `String` + +
+
+ +
+
+ +**request:** `Seed::Playlist::Types::PlaylistCreateRequest` + +
+
+
+
+ + +
+
+
+ +
client.Playlist.GetPlaylists(ServiceParam) -> Internal::Types::Array[Seed::Playlist::Types::Playlist] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the user's playlists +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.playlist.get_playlists({ + serviceParam:1, + limit:1, + otherField:'otherField', + multiLineDocs:'multiLineDocs' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `Integer` + +
+
+ +
+
+ +**limit:** `Integer` + +
+
+ +
+
+ +**otherField:** `String` — i'm another field + +
+
+ +
+
+ +**multiLineDocs:** `String` + +I'm a multiline +description + +
+
+ +
+
+ +**optionalMultipleField:** `String` + +
+
+ +
+
+ +**multipleField:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Playlist.GetPlaylist(ServiceParam, PlaylistId) -> Seed::Playlist::Types::Playlist +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a playlist +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.playlist.get_playlist(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `Integer` + +
+
+ +
+
+ +**playlistId:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Playlist.UpdatePlaylist(ServiceParam, PlaylistId, request) -> Seed::Playlist::Types::Playlist +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a playlist +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.playlist.update_playlist({ + name:'name', + problems:['problems', 'problems'] +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `Integer` + +
+
+ +
+
+ +**playlistId:** `String` + +
+
+ +
+
+ +**request:** `Seed::Playlist::Types::UpdatePlaylistRequest` + +
+
+
+
+ + +
+
+
+ +
client.Playlist.DeletePlaylist(ServiceParam, PlaylistId) -> +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes a playlist +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.playlist.delete_playlist(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**serviceParam:** `Integer` + +
+
+ +
+
+ +**playlistId:** `String` + +
+
+
+
+ + +
+
+
+ +## Problem +
client.Problem.CreateProblem(request) -> Seed::Problem::Types::CreateProblemResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a problem +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.problem.create_problem({ + problemName:'problemName', + problemDescription:{ + boards:[] + }, + files:{}, + inputParams:[{ + name:'name' + }, { + name:'name' + }], + testcases:[{ + testCase:{ + id:'id', + params:[] + } + }, { + testCase:{ + id:'id', + params:[] + } + }], + methodName:'methodName' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Problem::Types::CreateProblemRequest` + +
+
+
+
+ + +
+
+
+ +
client.Problem.UpdateProblem(ProblemId, request) -> Seed::Problem::Types::UpdateProblemResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates a problem +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.problem.update_problem({ + problemName:'problemName', + problemDescription:{ + boards:[] + }, + files:{}, + inputParams:[{ + name:'name' + }, { + name:'name' + }], + testcases:[{ + testCase:{ + id:'id', + params:[] + } + }, { + testCase:{ + id:'id', + params:[] + } + }], + methodName:'methodName' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `String` + +
+
+ +
+
+ +**request:** `Seed::Problem::Types::CreateProblemRequest` + +
+
+
+
+ + +
+
+
+ +
client.Problem.DeleteProblem(ProblemId) -> +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Soft deletes a problem +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.problem.delete_problem(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Problem.GetDefaultStarterFiles(request) -> Seed::Problem::Types::GetDefaultStarterFilesResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns default starter files for problem +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.problem.get_default_starter_files({ + inputParams:[{ + name:'name' + }, { + name:'name' + }], + methodName:'methodName' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**inputParams:** `Internal::Types::Array[Seed::Problem::Types::VariableTypeAndName]` + +
+
+ +
+
+ +**outputType:** `Seed::Commons::Types::VariableType` + +
+
+ +
+
+ +**methodName:** `String` + +The name of the `method` that the student has to complete. +The method name cannot include the following characters: + - Greater Than `>` + - Less Than `<`` + - Equals `=` + - Period `.` + +
+
+
+
+ + +
+
+
+ +## Submission +
client.Submission.CreateExecutionSession(Language) -> Seed::Submission::Types::ExecutionSessionResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns sessionId and execution server URL for session. Spins up server. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.submission.create_execution_session(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**language:** `Seed::Commons::Types::Language` + +
+
+
+
+ + +
+
+
+ +
client.Submission.GetExecutionSession(SessionId) -> Seed::Submission::Types::ExecutionSessionResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns execution server URL for session. Returns empty if session isn't registered. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.submission.get_execution_session(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**sessionId:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Submission.StopExecutionSession(SessionId) -> +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Stops execution session. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.submission.stop_execution_session(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**sessionId:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Submission.GetExecutionSessionsState() -> Seed::Submission::Types::GetExecutionSessionStateResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.submission.get_execution_sessions_state(); +``` +
+
+
+
+ + +
+
+
+ +## Sysprop +
client.Sysprop.SetNumWarmInstances(Language, NumWarmInstances) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.sysprop.set_num_warm_instances(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**language:** `Seed::Commons::Types::Language` + +
+
+ +
+
+ +**numWarmInstances:** `Integer` + +
+
+
+
+ + +
+
+
+ +
client.Sysprop.GetNumWarmInstances() -> Internal::Types::Hash[Seed::Commons::Types::Language, Integer] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.sysprop.get_num_warm_instances(); +``` +
+
+
+
+ + +
+
+
+ +## V2 Problem +
client.V2.Problem.GetLightweightProblems() -> Internal::Types::Array[Seed::V2::Problem::Types::LightweightProblemInfoV2] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns lightweight versions of all problems +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.v_2.problem.get_lightweight_problems(); +``` +
+
+
+
+ + +
+
+
+ +
client.V2.Problem.GetProblems() -> Internal::Types::Array[Seed::V2::Problem::Types::ProblemInfoV2] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns latest versions of all problems +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.v_2.problem.get_problems(); +``` +
+
+
+
+ + +
+
+
+ +
client.V2.Problem.GetLatestProblem(ProblemId) -> Seed::V2::Problem::Types::ProblemInfoV2 +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns latest version of a problem +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.v_2.problem.get_latest_problem(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `String` + +
+
+
+
+ + +
+
+
+ +
client.V2.Problem.GetProblemVersion(ProblemId, ProblemVersion) -> Seed::V2::Problem::Types::ProblemInfoV2 +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns requested version of a problem +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.v_2.problem.get_problem_version(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `String` + +
+
+ +
+
+ +**problemVersion:** `Integer` + +
+
+
+
+ + +
+
+
+ +## V2 V3 Problem +
client.V2.V3.Problem.GetLightweightProblems() -> Internal::Types::Array[Seed::V2::V3::Problem::Types::LightweightProblemInfoV2] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns lightweight versions of all problems +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.v_2.problem.get_lightweight_problems(); +``` +
+
+
+
+ + +
+
+
+ +
client.V2.V3.Problem.GetProblems() -> Internal::Types::Array[Seed::V2::V3::Problem::Types::ProblemInfoV2] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns latest versions of all problems +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.v_2.problem.get_problems(); +``` +
+
+
+
+ + +
+
+
+ +
client.V2.V3.Problem.GetLatestProblem(ProblemId) -> Seed::V2::V3::Problem::Types::ProblemInfoV2 +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns latest version of a problem +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.v_2.problem.get_latest_problem(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `String` + +
+
+
+
+ + +
+
+
+ +
client.V2.V3.Problem.GetProblemVersion(ProblemId, ProblemVersion) -> Seed::V2::V3::Problem::Types::ProblemInfoV2 +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns requested version of a problem +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.v_2.problem.get_problem_version(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**problemId:** `String` + +
+
+ +
+
+ +**problemVersion:** `Integer` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/trace/test/custom.test.rb b/seed/ruby-sdk-v2/trace/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/trace/test/custom.test.rb +++ b/seed/ruby-sdk-v2/trace/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/undiscriminated-unions/reference.md b/seed/ruby-sdk-v2/undiscriminated-unions/reference.md new file mode 100644 index 00000000000..b345c4653c3 --- /dev/null +++ b/seed/ruby-sdk-v2/undiscriminated-unions/reference.md @@ -0,0 +1,226 @@ +# Reference +## Union +
client.Union.Get(request) -> Seed::Union::Types::MyUnion +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.union.get(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Union::Types::MyUnion` + +
+
+
+
+ + +
+
+
+ +
client.Union.GetMetadata() -> Internal::Types::Hash[Seed::Union::Types::Key, String] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.union.get_metadata(); +``` +
+
+
+
+ + +
+
+
+ +
client.Union.UpdateMetadata(request) -> Internal::Types::Boolean +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.union.update_metadata(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Union::Types::MetadataUnion` + +
+
+
+
+ + +
+
+
+ +
client.Union.Call(request) -> Internal::Types::Boolean +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.union.call({}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Union::Types::Request` + +
+
+
+
+ + +
+
+
+ +
client.Union.DuplicateTypesUnion(request) -> Seed::Union::Types::UnionWithDuplicateTypes +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.union.duplicate_types_union(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Union::Types::UnionWithDuplicateTypes` + +
+
+
+
+ + +
+
+
+ +
client.Union.NestedUnions(request) -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.union.nested_unions(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Union::Types::NestedUnionRoot` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/undiscriminated-unions/test/custom.test.rb b/seed/ruby-sdk-v2/undiscriminated-unions/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/undiscriminated-unions/test/custom.test.rb +++ b/seed/ruby-sdk-v2/undiscriminated-unions/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/unions/reference.md b/seed/ruby-sdk-v2/unions/reference.md new file mode 100644 index 00000000000..9c44e683783 --- /dev/null +++ b/seed/ruby-sdk-v2/unions/reference.md @@ -0,0 +1,202 @@ +# Reference +## Bigunion +
client.Bigunion.Get(Id) -> Seed::Bigunion::Types::BigUnion +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.bigunion.get(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Bigunion.Update(request) -> Internal::Types::Boolean +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.bigunion.update(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Bigunion::Types::BigUnion` + +
+
+
+
+ + +
+
+
+ +
client.Bigunion.UpdateMany(request) -> Internal::Types::Hash[String, Internal::Types::Boolean] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.bigunion.update_many(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Internal::Types::Array[Seed::Bigunion::Types::BigUnion]` + +
+
+
+
+ + +
+
+
+ +## Union +
client.Union.Get(Id) -> Seed::Union::Types::Shape +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.bigunion.get(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Union.Update(request) -> Internal::Types::Boolean +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.bigunion.update(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Union::Types::Shape` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/unions/test/custom.test.rb b/seed/ruby-sdk-v2/unions/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/unions/test/custom.test.rb +++ b/seed/ruby-sdk-v2/unions/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/unknown/reference.md b/seed/ruby-sdk-v2/unknown/reference.md new file mode 100644 index 00000000000..583c860edf1 --- /dev/null +++ b/seed/ruby-sdk-v2/unknown/reference.md @@ -0,0 +1,81 @@ +# Reference +## Unknown +
client.Unknown.Post(request) -> Internal::Types::Array[Internal::Types::Hash[String, Object]] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.unknown.post(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Internal::Types::Hash[String, Object]` + +
+
+
+
+ + +
+
+
+ +
client.Unknown.PostObject(request) -> Internal::Types::Array[Internal::Types::Hash[String, Object]] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.unknown.post_object({}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Seed::Unknown::Types::MyObject` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/unknown/test/custom.test.rb b/seed/ruby-sdk-v2/unknown/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/unknown/test/custom.test.rb +++ b/seed/ruby-sdk-v2/unknown/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/validation/reference.md b/seed/ruby-sdk-v2/validation/reference.md new file mode 100644 index 00000000000..687c039e4ec --- /dev/null +++ b/seed/ruby-sdk-v2/validation/reference.md @@ -0,0 +1,128 @@ +# Reference +
client.Create(request) -> Seed::Types::Type +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.create({ + decimal:2.2, + even:100, + name:'fern' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**decimal:** `Integer` + +
+
+ +
+
+ +**even:** `Integer` + +
+
+ +
+
+ +**name:** `String` + +
+
+ +
+
+ +**shape:** `Seed::Types::Shape` + +
+
+
+
+ + +
+
+
+ +
client.Get() -> Seed::Types::Type +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.get({ + decimal:2.2, + even:100, + name:'fern' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**decimal:** `Integer` + +
+
+ +
+
+ +**even:** `Integer` + +
+
+ +
+
+ +**name:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/validation/test/custom.test.rb b/seed/ruby-sdk-v2/validation/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/validation/test/custom.test.rb +++ b/seed/ruby-sdk-v2/validation/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/variables/reference.md b/seed/ruby-sdk-v2/variables/reference.md new file mode 100644 index 00000000000..9a91bc2a002 --- /dev/null +++ b/seed/ruby-sdk-v2/variables/reference.md @@ -0,0 +1,41 @@ +# Reference +## Service +
client.Service.Post(EndpointParam) -> +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.service.post(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**endpointParam:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/variables/test/custom.test.rb b/seed/ruby-sdk-v2/variables/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/variables/test/custom.test.rb +++ b/seed/ruby-sdk-v2/variables/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/version-no-default/reference.md b/seed/ruby-sdk-v2/version-no-default/reference.md new file mode 100644 index 00000000000..fe883dc0dc1 --- /dev/null +++ b/seed/ruby-sdk-v2/version-no-default/reference.md @@ -0,0 +1,41 @@ +# Reference +## User +
client.User.GetUser(UserId) -> Seed::User::Types::User +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.user.get_user(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**userId:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/version-no-default/test/custom.test.rb b/seed/ruby-sdk-v2/version-no-default/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/version-no-default/test/custom.test.rb +++ b/seed/ruby-sdk-v2/version-no-default/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/version/reference.md b/seed/ruby-sdk-v2/version/reference.md new file mode 100644 index 00000000000..fe883dc0dc1 --- /dev/null +++ b/seed/ruby-sdk-v2/version/reference.md @@ -0,0 +1,41 @@ +# Reference +## User +
client.User.GetUser(UserId) -> Seed::User::Types::User +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.user.get_user(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**userId:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/version/test/custom.test.rb b/seed/ruby-sdk-v2/version/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/version/test/custom.test.rb +++ b/seed/ruby-sdk-v2/version/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/websocket-bearer-auth/reference.md b/seed/ruby-sdk-v2/websocket-bearer-auth/reference.md new file mode 100644 index 00000000000..4a938e09d06 --- /dev/null +++ b/seed/ruby-sdk-v2/websocket-bearer-auth/reference.md @@ -0,0 +1 @@ +# Reference \ No newline at end of file diff --git a/seed/ruby-sdk-v2/websocket-bearer-auth/test/custom.test.rb b/seed/ruby-sdk-v2/websocket-bearer-auth/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/websocket-bearer-auth/test/custom.test.rb +++ b/seed/ruby-sdk-v2/websocket-bearer-auth/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/websocket-inferred-auth/reference.md b/seed/ruby-sdk-v2/websocket-inferred-auth/reference.md new file mode 100644 index 00000000000..1355fc272cb --- /dev/null +++ b/seed/ruby-sdk-v2/websocket-inferred-auth/reference.md @@ -0,0 +1,184 @@ +# Reference +## Auth +
client.Auth.GetTokenWithClientCredentials(request) -> Seed::Auth::Types::TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.auth.get_token_with_client_credentials({ + xApiKey:'X-Api-Key', + clientId:'client_id', + clientSecret:'client_secret', + audience:'https://api.example.com', + grantType:'client_credentials', + scope:'scope' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**xApiKey:** `String` + +
+
+ +
+
+ +**clientId:** `String` + +
+
+ +
+
+ +**clientSecret:** `String` + +
+
+ +
+
+ +**audience:** `String` + +
+
+ +
+
+ +**grantType:** `String` + +
+
+ +
+
+ +**scope:** `String` + +
+
+
+
+ + +
+
+
+ +
client.Auth.RefreshToken(request) -> Seed::Auth::Types::TokenResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.auth.refresh_token({ + xApiKey:'X-Api-Key', + clientId:'client_id', + clientSecret:'client_secret', + refreshToken:'refresh_token', + audience:'https://api.example.com', + grantType:'refresh_token', + scope:'scope' +}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**xApiKey:** `String` + +
+
+ +
+
+ +**clientId:** `String` + +
+
+ +
+
+ +**clientSecret:** `String` + +
+
+ +
+
+ +**refreshToken:** `String` + +
+
+ +
+
+ +**audience:** `String` + +
+
+ +
+
+ +**grantType:** `String` + +
+
+ +
+
+ +**scope:** `String` + +
+
+
+
+ + +
+
+
diff --git a/seed/ruby-sdk-v2/websocket-inferred-auth/test/custom.test.rb b/seed/ruby-sdk-v2/websocket-inferred-auth/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/websocket-inferred-auth/test/custom.test.rb +++ b/seed/ruby-sdk-v2/websocket-inferred-auth/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end diff --git a/seed/ruby-sdk-v2/websocket/reference.md b/seed/ruby-sdk-v2/websocket/reference.md new file mode 100644 index 00000000000..4a938e09d06 --- /dev/null +++ b/seed/ruby-sdk-v2/websocket/reference.md @@ -0,0 +1 @@ +# Reference \ No newline at end of file diff --git a/seed/ruby-sdk-v2/websocket/test/custom.test.rb b/seed/ruby-sdk-v2/websocket/test/custom.test.rb index f5f4f8326c9..4bd57989d43 100644 --- a/seed/ruby-sdk-v2/websocket/test/custom.test.rb +++ b/seed/ruby-sdk-v2/websocket/test/custom.test.rb @@ -9,7 +9,7 @@ # This test is run via command line: rake customtest describe "Custom Test" do - it "Defalt" do + it "Default" do refute false end end