owasp-nest 0.2.5 → 0.3.1

package/docs/sdks/projects/README.md

@@ -1,156 +0,0 @@
-# Projects
-(*projects*)
-
-## Overview
-
-### Available Operations
-
-* [listProjects](#listprojects) - List projects
-* [getProject](#getproject) - Get project
-
-## listProjects
-
-Retrieve a paginated list of OWASP projects.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="list_projects" method="get" path="/api/v0/projects/" -->
-```typescript
-import { Nest } from "owasp-nest";
-
-const nest = new Nest({
-  apiKey: process.env["NEST_API_KEY"] ?? "",
-});
-
-async function run() {
-  const result = await nest.projects.listProjects({
-    ordering: "-created_at",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { NestCore } from "owasp-nest/core.js";
-import { projectsListProjects } from "owasp-nest/funcs/projectsListProjects.js";
-
-// Use `NestCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const nest = new NestCore({
-  apiKey: process.env["NEST_API_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await projectsListProjects(nest, {
-    ordering: "-created_at",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("projectsListProjects failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListProjectsRequest](../../models/operations/listprojectsrequest.md)                                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[models.PagedProject](../../models/pagedproject.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.NestApiError | 4XX, 5XX            | \*/\*               |
-
-## getProject
-
-Retrieve project details.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="get_project" method="get" path="/api/v0/projects/{project_id}" -->
-```typescript
-import { Nest } from "owasp-nest";
-
-const nest = new Nest({
-  apiKey: process.env["NEST_API_KEY"] ?? "",
-});
-
-async function run() {
-  const result = await nest.projects.getProject({
-    projectId: "Nest",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { NestCore } from "owasp-nest/core.js";
-import { projectsGetProject } from "owasp-nest/funcs/projectsGetProject.js";
-
-// Use `NestCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const nest = new NestCore({
-  apiKey: process.env["NEST_API_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await projectsGetProject(nest, {
-    projectId: "Nest",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("projectsGetProject failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetProjectRequest](../../models/operations/getprojectrequest.md)                                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[models.ProjectDetail](../../models/projectdetail.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.ProjectError | 404                 | application/json    |
-| errors.NestApiError | 4XX, 5XX            | \*/\*               |

package/docs/sdks/releases/README.md

@@ -1,164 +0,0 @@
-# Releases
-(*releases*)
-
-## Overview
-
-### Available Operations
-
-* [listReleases](#listreleases) - List releases
-* [getRelease](#getrelease) - Get release
-
-## listReleases
-
-Retrieve a paginated list of GitHub releases.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="list_releases" method="get" path="/api/v0/releases/" -->
-```typescript
-import { Nest } from "owasp-nest";
-
-const nest = new Nest({
-  apiKey: process.env["NEST_API_KEY"] ?? "",
-});
-
-async function run() {
-  const result = await nest.releases.listReleases({
-    organization: "OWASP",
-    repository: "Nest",
-    tagName: "0.2.10",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { NestCore } from "owasp-nest/core.js";
-import { releasesListReleases } from "owasp-nest/funcs/releasesListReleases.js";
-
-// Use `NestCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const nest = new NestCore({
-  apiKey: process.env["NEST_API_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await releasesListReleases(nest, {
-    organization: "OWASP",
-    repository: "Nest",
-    tagName: "0.2.10",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("releasesListReleases failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListReleasesRequest](../../models/operations/listreleasesrequest.md)                                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[models.PagedRelease](../../models/pagedrelease.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.NestApiError | 4XX, 5XX            | \*/\*               |
-
-## getRelease
-
-Retrieve a specific GitHub release by organization, repository, and tag name.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="get_release" method="get" path="/api/v0/releases/{organization_id}/{repository_id}/{release_id}" -->
-```typescript
-import { Nest } from "owasp-nest";
-
-const nest = new Nest({
-  apiKey: process.env["NEST_API_KEY"] ?? "",
-});
-
-async function run() {
-  const result = await nest.releases.getRelease({
-    organizationId: "OWASP",
-    repositoryId: "Nest",
-    releaseId: "0.2.10",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { NestCore } from "owasp-nest/core.js";
-import { releasesGetRelease } from "owasp-nest/funcs/releasesGetRelease.js";
-
-// Use `NestCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const nest = new NestCore({
-  apiKey: process.env["NEST_API_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await releasesGetRelease(nest, {
-    organizationId: "OWASP",
-    repositoryId: "Nest",
-    releaseId: "0.2.10",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("releasesGetRelease failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetReleaseRequest](../../models/operations/getreleaserequest.md)                                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[models.ReleaseDetail](../../models/releasedetail.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.ReleaseError | 404                 | application/json    |
-| errors.NestApiError | 4XX, 5XX            | \*/\*               |

package/docs/sdks/repositories/README.md

@@ -1,158 +0,0 @@
-# Repositories
-(*repositories*)
-
-## Overview
-
-### Available Operations
-
-* [listRepositories](#listrepositories) - List repositories
-* [getRepository](#getrepository) - Get repository
-
-## listRepositories
-
-Retrieve a paginated list of GitHub repositories.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="list_repositories" method="get" path="/api/v0/repositories/" -->
-```typescript
-import { Nest } from "owasp-nest";
-
-const nest = new Nest({
-  apiKey: process.env["NEST_API_KEY"] ?? "",
-});
-
-async function run() {
-  const result = await nest.repositories.listRepositories({
-    organizationId: "OWASP",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { NestCore } from "owasp-nest/core.js";
-import { repositoriesListRepositories } from "owasp-nest/funcs/repositoriesListRepositories.js";
-
-// Use `NestCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const nest = new NestCore({
-  apiKey: process.env["NEST_API_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await repositoriesListRepositories(nest, {
-    organizationId: "OWASP",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("repositoriesListRepositories failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListRepositoriesRequest](../../models/operations/listrepositoriesrequest.md)                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[models.PagedRepository](../../models/pagedrepository.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.NestApiError | 4XX, 5XX            | \*/\*               |
-
-## getRepository
-
-Retrieve a specific GitHub repository by organization and repository name.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="get_repository" method="get" path="/api/v0/repositories/{organization_id}/{repository_id}" -->
-```typescript
-import { Nest } from "owasp-nest";
-
-const nest = new Nest({
-  apiKey: process.env["NEST_API_KEY"] ?? "",
-});
-
-async function run() {
-  const result = await nest.repositories.getRepository({
-    organizationId: "OWASP",
-    repositoryId: "Nest",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { NestCore } from "owasp-nest/core.js";
-import { repositoriesGetRepository } from "owasp-nest/funcs/repositoriesGetRepository.js";
-
-// Use `NestCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const nest = new NestCore({
-  apiKey: process.env["NEST_API_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await repositoriesGetRepository(nest, {
-    organizationId: "OWASP",
-    repositoryId: "Nest",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("repositoriesGetRepository failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetRepositoryRequest](../../models/operations/getrepositoryrequest.md)                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[models.RepositoryDetail](../../models/repositorydetail.md)\>**
-
-### Errors
-
-| Error Type             | Status Code            | Content Type           |
-| ---------------------- | ---------------------- | ---------------------- |
-| errors.RepositoryError | 404                    | application/json       |
-| errors.NestApiError    | 4XX, 5XX               | \*/\*                  |

package/docs/sdks/sponsors/README.md

@@ -1,156 +0,0 @@
-# Sponsors
-(*sponsors*)
-
-## Overview
-
-### Available Operations
-
-* [listSponsors](#listsponsors) - List sponsors
-* [getSponsor](#getsponsor) - Get sponsor
-
-## listSponsors
-
-Retrieve a paginated list of OWASP sponsors.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="list_sponsors" method="get" path="/api/v0/sponsors/" -->
-```typescript
-import { Nest } from "owasp-nest";
-
-const nest = new Nest({
-  apiKey: process.env["NEST_API_KEY"] ?? "",
-});
-
-async function run() {
-  const result = await nest.sponsors.listSponsors({
-    sponsorType: "Silver",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { NestCore } from "owasp-nest/core.js";
-import { sponsorsListSponsors } from "owasp-nest/funcs/sponsorsListSponsors.js";
-
-// Use `NestCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const nest = new NestCore({
-  apiKey: process.env["NEST_API_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await sponsorsListSponsors(nest, {
-    sponsorType: "Silver",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("sponsorsListSponsors failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListSponsorsRequest](../../models/operations/listsponsorsrequest.md)                                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[models.PagedSponsor](../../models/pagedsponsor.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.NestApiError | 4XX, 5XX            | \*/\*               |
-
-## getSponsor
-
-Retrieve a sponsor details.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="get_sponsor" method="get" path="/api/v0/sponsors/{sponsor_id}" -->
-```typescript
-import { Nest } from "owasp-nest";
-
-const nest = new Nest({
-  apiKey: process.env["NEST_API_KEY"] ?? "",
-});
-
-async function run() {
-  const result = await nest.sponsors.getSponsor({
-    sponsorId: "adobe",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { NestCore } from "owasp-nest/core.js";
-import { sponsorsGetSponsor } from "owasp-nest/funcs/sponsorsGetSponsor.js";
-
-// Use `NestCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const nest = new NestCore({
-  apiKey: process.env["NEST_API_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await sponsorsGetSponsor(nest, {
-    sponsorId: "adobe",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("sponsorsGetSponsor failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetSponsorRequest](../../models/operations/getsponsorrequest.md)                                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[models.SponsorDetail](../../models/sponsordetail.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.SponsorError | 404                 | application/json    |
-| errors.NestApiError | 4XX, 5XX            | \*/\*               |