owasp-nest 0.2.3 → 0.2.5

package/docs/sdks/projects/README.md

@@ -73,7 +73,7 @@ run();
 
 ### Response
 
-**Promise\<[models.PagedProjectSchema](../../models/pagedprojectschema.md)\>**
+**Promise\<[models.PagedProject](../../models/pagedproject.md)\>**
 
 ### Errors
 
@@ -146,11 +146,11 @@ run();
 
 ### Response
 
-**Promise\<[models.ProjectSchema](../../models/projectschema.md)\>**
+**Promise\<[models.ProjectDetail](../../models/projectdetail.md)\>**
 
 ### Errors
 
-| Error Type                  | Status Code                 | Content Type                |
-| --------------------------- | --------------------------- | --------------------------- |
-| errors.ProjectErrorResponse | 404                         | application/json            |
-| errors.NestApiError         | 4XX, 5XX                    | \*/\*                       |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.ProjectError | 404                 | application/json    |
+| errors.NestApiError | 4XX, 5XX            | \*/\*               |

package/docs/sdks/releases/README.md

@@ -6,6 +6,7 @@
 ### Available Operations
 
 * [listReleases](#listreleases) - List releases
+* [getRelease](#getrelease) - Get release
 
 ## listReleases
 
@@ -23,7 +24,9 @@ const nest = new Nest({
 
 async function run() {
   const result = await nest.releases.listReleases({
-    tagName: "v1.0.0",
+    organization: "OWASP",
+    repository: "Nest",
+    tagName: "0.2.10",
   });
 
   console.log(result);
@@ -48,7 +51,9 @@ const nest = new NestCore({
 
 async function run() {
   const res = await releasesListReleases(nest, {
-    tagName: "v1.0.0",
+    organization: "OWASP",
+    repository: "Nest",
+    tagName: "0.2.10",
   });
   if (res.ok) {
     const { value: result } = res;
@@ -72,10 +77,88 @@ run();
 
 ### Response
 
-**Promise\<[models.PagedReleaseSchema](../../models/pagedreleaseschema.md)\>**
+**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

@@ -6,6 +6,7 @@
 ### Available Operations
 
 * [listRepositories](#listrepositories) - List repositories
+* [getRepository](#getrepository) - Get repository
 
 ## listRepositories
 
@@ -22,7 +23,9 @@ const nest = new Nest({
 });
 
 async function run() {
-  const result = await nest.repositories.listRepositories({});
+  const result = await nest.repositories.listRepositories({
+    organizationId: "OWASP",
+  });
 
   console.log(result);
 }
@@ -45,7 +48,9 @@ const nest = new NestCore({
 });
 
 async function run() {
-  const res = await repositoriesListRepositories(nest, {});
+  const res = await repositoriesListRepositories(nest, {
+    organizationId: "OWASP",
+  });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
@@ -68,10 +73,86 @@ run();
 
 ### Response
 
-**Promise\<[models.PagedRepositorySchema](../../models/pagedrepositoryschema.md)\>**
+**Promise\<[models.PagedRepository](../../models/pagedrepository.md)\>**
 
 ### Errors
 
 | Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
-| errors.NestApiError | 4XX, 5XX            | \*/\*               |
+| 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

@@ -73,7 +73,7 @@ run();
 
 ### Response
 
-**Promise\<[models.PagedSponsorSchema](../../models/pagedsponsorschema.md)\>**
+**Promise\<[models.PagedSponsor](../../models/pagedsponsor.md)\>**
 
 ### Errors
 
@@ -87,7 +87,7 @@ Retrieve a sponsor details.
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="get_sponsor" method="get" path="/api/v0/sponsors/{sponsor_key}" -->
+<!-- UsageSnippet language="typescript" operationID="get_sponsor" method="get" path="/api/v0/sponsors/{sponsor_id}" -->
 ```typescript
 import { Nest } from "owasp-nest";
 
@@ -97,7 +97,7 @@ const nest = new Nest({
 
 async function run() {
   const result = await nest.sponsors.getSponsor({
-    sponsorKey: "adobe",
+    sponsorId: "adobe",
   });
 
   console.log(result);
@@ -122,7 +122,7 @@ const nest = new NestCore({
 
 async function run() {
   const res = await sponsorsGetSponsor(nest, {
-    sponsorKey: "adobe",
+    sponsorId: "adobe",
   });
   if (res.ok) {
     const { value: result } = res;
@@ -146,11 +146,11 @@ run();
 
 ### Response
 
-**Promise\<[models.SponsorSchema](../../models/sponsorschema.md)\>**
+**Promise\<[models.SponsorDetail](../../models/sponsordetail.md)\>**
 
 ### Errors
 
-| Error Type                  | Status Code                 | Content Type                |
-| --------------------------- | --------------------------- | --------------------------- |
-| errors.SponsorErrorResponse | 404                         | application/json            |
-| errors.NestApiError         | 4XX, 5XX                    | \*/\*                       |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.SponsorError | 404                 | application/json    |
+| errors.NestApiError | 4XX, 5XX            | \*/\*               |

package/examples/chaptersListChapters.example.ts

@@ -20,7 +20,6 @@ const nest = new Nest({
 async function main() {
   const result = await nest.chapters.listChapters({
     country: "India",
-    region: "Asia",
   });
 
   console.log(result);

package/examples/package-lock.json

@@ -18,7 +18,7 @@
     },
     "..": {
       "name": "owasp-nest",
-      "version": "0.2.3",
+      "version": "0.2.5",
       "dependencies": {
         "zod": "^3.20.0"
       },

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "owasp-nest",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "owasp-nest",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "author": "Arkadii Yakovets",
   "type": "module",
   "tshy": {

package/src/funcs/chaptersGetChapter.ts

@@ -38,8 +38,8 @@ export function chaptersGetChapter(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    models.ChapterSchema,
-    | errors.ChapterErrorResponse
+    models.ChapterDetail,
+    | errors.ChapterError
     | NestError
     | ResponseValidationError
     | ConnectionError
@@ -64,8 +64,8 @@ async function $do(
 ): Promise<
   [
     Result<
-      models.ChapterSchema,
-      | errors.ChapterErrorResponse
+      models.ChapterDetail,
+      | errors.ChapterError
       | NestError
       | ResponseValidationError
       | ConnectionError
@@ -110,7 +110,7 @@ async function $do(
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "get_chapter",
-    oAuth2Scopes: [],
+    oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
 
@@ -152,8 +152,8 @@ async function $do(
   };
 
   const [result] = await M.match<
-    models.ChapterSchema,
-    | errors.ChapterErrorResponse
+    models.ChapterDetail,
+    | errors.ChapterError
     | NestError
     | ResponseValidationError
     | ConnectionError
@@ -163,8 +163,8 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, models.ChapterSchema$inboundSchema),
-    M.jsonErr(404, errors.ChapterErrorResponse$inboundSchema),
+    M.json(200, models.ChapterDetail$inboundSchema),
+    M.jsonErr(404, errors.ChapterError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/funcs/chaptersListChapters.ts

@@ -37,7 +37,7 @@ export function chaptersListChapters(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    models.PagedChapterSchema,
+    models.PagedChapter,
     | NestError
     | ResponseValidationError
     | ConnectionError
@@ -62,7 +62,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      models.PagedChapterSchema,
+      models.PagedChapter,
       | NestError
       | ResponseValidationError
       | ConnectionError
@@ -94,7 +94,6 @@ async function $do(
     "ordering": payload?.ordering,
     "page": payload?.page,
     "page_size": payload?.page_size,
-    "region": payload?.region,
   });
 
   const headers = new Headers(compactMap({
@@ -109,7 +108,7 @@ async function $do(
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "list_chapters",
-    oAuth2Scopes: [],
+    oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
 
@@ -148,7 +147,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    models.PagedChapterSchema,
+    models.PagedChapter,
     | NestError
     | ResponseValidationError
     | ConnectionError
@@ -158,7 +157,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, models.PagedChapterSchema$inboundSchema),
+    M.json(200, models.PagedChapter$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req);

package/src/funcs/committeesGetCommittee.ts

@@ -38,8 +38,8 @@ export function committeesGetCommittee(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    models.CommitteeSchema,
-    | errors.CommitteeErrorResponse
+    models.CommitteeDetail,
+    | errors.CommitteeError
     | NestError
     | ResponseValidationError
     | ConnectionError
@@ -64,8 +64,8 @@ async function $do(
 ): Promise<
   [
     Result<
-      models.CommitteeSchema,
-      | errors.CommitteeErrorResponse
+      models.CommitteeDetail,
+      | errors.CommitteeError
       | NestError
       | ResponseValidationError
       | ConnectionError
@@ -110,7 +110,7 @@ async function $do(
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "get_committee",
-    oAuth2Scopes: [],
+    oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
 
@@ -152,8 +152,8 @@ async function $do(
   };
 
   const [result] = await M.match<
-    models.CommitteeSchema,
-    | errors.CommitteeErrorResponse
+    models.CommitteeDetail,
+    | errors.CommitteeError
     | NestError
     | ResponseValidationError
     | ConnectionError
@@ -163,8 +163,8 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, models.CommitteeSchema$inboundSchema),
-    M.jsonErr(404, errors.CommitteeErrorResponse$inboundSchema),
+    M.json(200, models.CommitteeDetail$inboundSchema),
+    M.jsonErr(404, errors.CommitteeError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/funcs/committeesListCommittees.ts

@@ -37,7 +37,7 @@ export function committeesListCommittees(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    models.PagedCommitteeSchema,
+    models.PagedCommittee,
     | NestError
     | ResponseValidationError
     | ConnectionError
@@ -62,7 +62,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      models.PagedCommitteeSchema,
+      models.PagedCommittee,
       | NestError
       | ResponseValidationError
       | ConnectionError
@@ -107,7 +107,7 @@ async function $do(
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "list_committees",
-    oAuth2Scopes: [],
+    oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
 
@@ -146,7 +146,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    models.PagedCommitteeSchema,
+    models.PagedCommittee,
     | NestError
     | ResponseValidationError
     | ConnectionError
@@ -156,7 +156,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, models.PagedCommitteeSchema$inboundSchema),
+    M.json(200, models.PagedCommittee$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req);

package/src/funcs/communityGetMember.ts

@@ -38,8 +38,8 @@ export function communityGetMember(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    models.MemberSchema,
-    | errors.MemberErrorResponse
+    models.MemberDetail,
+    | errors.MemberError
     | NestError
     | ResponseValidationError
     | ConnectionError
@@ -64,8 +64,8 @@ async function $do(
 ): Promise<
   [
     Result<
-      models.MemberSchema,
-      | errors.MemberErrorResponse
+      models.MemberDetail,
+      | errors.MemberError
       | NestError
       | ResponseValidationError
       | ConnectionError
@@ -110,7 +110,7 @@ async function $do(
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "get_member",
-    oAuth2Scopes: [],
+    oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
 
@@ -152,8 +152,8 @@ async function $do(
   };
 
   const [result] = await M.match<
-    models.MemberSchema,
-    | errors.MemberErrorResponse
+    models.MemberDetail,
+    | errors.MemberError
     | NestError
     | ResponseValidationError
     | ConnectionError
@@ -163,8 +163,8 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, models.MemberSchema$inboundSchema),
-    M.jsonErr(404, errors.MemberErrorResponse$inboundSchema),
+    M.json(200, models.MemberDetail$inboundSchema),
+    M.jsonErr(404, errors.MemberError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/funcs/communityGetOrganization.ts

@@ -38,8 +38,8 @@ export function communityGetOrganization(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    models.OrganizationSchema,
-    | errors.OrganizationErrorResponse
+    models.OrganizationDetail,
+    | errors.OrganizationError
     | NestError
     | ResponseValidationError
     | ConnectionError
@@ -64,8 +64,8 @@ async function $do(
 ): Promise<
   [
     Result<
-      models.OrganizationSchema,
-      | errors.OrganizationErrorResponse
+      models.OrganizationDetail,
+      | errors.OrganizationError
       | NestError
       | ResponseValidationError
       | ConnectionError
@@ -112,7 +112,7 @@ async function $do(
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "get_organization",
-    oAuth2Scopes: [],
+    oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
 
@@ -154,8 +154,8 @@ async function $do(
   };
 
   const [result] = await M.match<
-    models.OrganizationSchema,
-    | errors.OrganizationErrorResponse
+    models.OrganizationDetail,
+    | errors.OrganizationError
     | NestError
     | ResponseValidationError
     | ConnectionError
@@ -165,8 +165,8 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, models.OrganizationSchema$inboundSchema),
-    M.jsonErr(404, errors.OrganizationErrorResponse$inboundSchema),
+    M.json(200, models.OrganizationDetail$inboundSchema),
+    M.jsonErr(404, errors.OrganizationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });