owasp-nest 0.2.0 → 0.2.1

package/docs/sdks/projects/README.md

@@ -5,15 +5,16 @@
 
 ### Available Operations
 
-* [listProjects](#listprojects) - List projects
+* [appsApiRestV0ProjectListProjects](#appsapirestv0projectlistprojects) - List projects
+* [appsApiRestV0ProjectGetProject](#appsapirestv0projectgetproject) - Get project
 
-## listProjects
+## appsApiRestV0ProjectListProjects
 
 Retrieve a paginated list of OWASP projects.
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="list_projects" method="get" path="/api/v0/projects/" -->
+<!-- UsageSnippet language="typescript" operationID="apps_api_rest_v0_project_list_projects" method="get" path="/api/v0/projects/" -->
 ```typescript
 import { Nest } from "owasp-nest";
 
@@ -22,7 +23,9 @@ const nest = new Nest({
 });
 
 async function run() {
-  const result = await nest.projects.listProjects({});
+  const result = await nest.projects.appsApiRestV0ProjectListProjects({
+    ordering: "-created_at",
+  });
 
   console.log(result);
 }
@@ -36,7 +39,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NestCore } from "owasp-nest/core.js";
-import { projectsListProjects } from "owasp-nest/funcs/projectsListProjects.js";
+import { projectsAppsApiRestV0ProjectListProjects } from "owasp-nest/funcs/projectsAppsApiRestV0ProjectListProjects.js";
 
 // Use `NestCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -45,12 +48,14 @@ const nest = new NestCore({
 });
 
 async function run() {
-  const res = await projectsListProjects(nest, {});
+  const res = await projectsAppsApiRestV0ProjectListProjects(nest, {
+    ordering: "-created_at",
+  });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("projectsListProjects failed:", res.error);
+    console.log("projectsAppsApiRestV0ProjectListProjects failed:", res.error);
   }
 }
 
@@ -61,7 +66,7 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListProjectsRequest](../../models/operations/listprojectsrequest.md)                                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.AppsApiRestV0ProjectListProjectsRequest](../../models/operations/appsapirestv0projectlistprojectsrequest.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.                                                                                                               |
@@ -74,4 +79,78 @@ run();
 
 | Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
-| errors.NestApiError | 4XX, 5XX            | \*/\*               |
+| errors.NestApiError | 4XX, 5XX            | \*/\*               |
+
+## appsApiRestV0ProjectGetProject
+
+Retrieve project details.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="apps_api_rest_v0_project_get_project" method="get" path="/api/v0/projects/{project_id}" -->
+```typescript
+import { Nest } from "owasp-nest";
+
+const nest = new Nest({
+  apiKeyHeader: process.env["NEST_API_KEY_HEADER"] ?? "",
+});
+
+async function run() {
+  const result = await nest.projects.appsApiRestV0ProjectGetProject({
+    projectId: "Nest",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { NestCore } from "owasp-nest/core.js";
+import { projectsAppsApiRestV0ProjectGetProject } from "owasp-nest/funcs/projectsAppsApiRestV0ProjectGetProject.js";
+
+// Use `NestCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const nest = new NestCore({
+  apiKeyHeader: process.env["NEST_API_KEY_HEADER"] ?? "",
+});
+
+async function run() {
+  const res = await projectsAppsApiRestV0ProjectGetProject(nest, {
+    projectId: "Nest",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("projectsAppsApiRestV0ProjectGetProject failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.AppsApiRestV0ProjectGetProjectRequest](../../models/operations/appsapirestv0projectgetprojectrequest.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.ProjectSchema](../../models/projectschema.md)\>**
+
+### Errors
+
+| Error Type                  | Status Code                 | Content Type                |
+| --------------------------- | --------------------------- | --------------------------- |
+| errors.ProjectErrorResponse | 404                         | application/json            |
+| errors.NestApiError         | 4XX, 5XX                    | \*/\*                       |

package/examples/{chaptersListChapters.example.ts → chaptersAppsApiRestV0ChapterListChapters.example.ts}

@@ -8,7 +8,7 @@ dotenv.config();
  * Example usage of the owasp-nest SDK
  *
  * To run this example from the examples directory:
- * npm run build && npx tsx chaptersListChapters.example.ts
+ * npm run build && npx tsx chaptersAppsApiRestV0ChapterListChapters.example.ts
  */
 
 import { Nest } from "owasp-nest";
@@ -18,10 +18,7 @@ const nest = new Nest({
 });
 
 async function main() {
-  const result = await nest.chapters.listChapters({
-    country: "India",
-    region: "Asia",
-  });
+  const result = await nest.chapters.appsApiRestV0ChapterListChapters({});
 
   console.log(result);
 }

package/examples/package-lock.json

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

package/jsr.json

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

package/package.json

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

package/src/funcs/{chaptersGetChapter.ts → chaptersAppsApiRestV0ChapterGetChapter.ts}

@@ -32,9 +32,9 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Retrieve chapter details.
  */
-export function chaptersGetChapter(
+export function chaptersAppsApiRestV0ChapterGetChapter(
   client: NestCore,
-  request: operations.GetChapterRequest,
+  request: operations.AppsApiRestV0ChapterGetChapterRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
@@ -59,7 +59,7 @@ export function chaptersGetChapter(
 
 async function $do(
   client: NestCore,
-  request: operations.GetChapterRequest,
+  request: operations.AppsApiRestV0ChapterGetChapterRequest,
   options?: RequestOptions,
 ): Promise<
   [
@@ -80,7 +80,10 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) => operations.GetChapterRequest$outboundSchema.parse(value),
+    (value) =>
+      operations.AppsApiRestV0ChapterGetChapterRequest$outboundSchema.parse(
+        value,
+      ),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -90,13 +93,13 @@ async function $do(
   const body = null;
 
   const pathParams = {
-    key: encodeSimple("key", payload.key, {
+    chapter_id: encodeSimple("chapter_id", payload.chapter_id, {
       explode: false,
       charEncoding: "percent",
     }),
   };
 
-  const path = pathToFunc("/api/v0/chapters/{key}")(pathParams);
+  const path = pathToFunc("/api/v0/chapters/{chapter_id}")(pathParams);
 
   const headers = new Headers(compactMap({
     Accept: "application/json",
@@ -109,7 +112,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "get_chapter",
+    operationID: "apps_api_rest_v0_chapter_get_chapter",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,

package/src/funcs/{chaptersListChapters.ts → chaptersAppsApiRestV0ChapterListChapters.ts}

@@ -31,9 +31,9 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Retrieve a paginated list of OWASP chapters.
  */
-export function chaptersListChapters(
+export function chaptersAppsApiRestV0ChapterListChapters(
   client: NestCore,
-  request?: operations.ListChaptersRequest | undefined,
+  request?: operations.AppsApiRestV0ChapterListChaptersRequest | undefined,
   options?: RequestOptions,
 ): APIPromise<
   Result<
@@ -57,7 +57,7 @@ export function chaptersListChapters(
 
 async function $do(
   client: NestCore,
-  request?: operations.ListChaptersRequest | undefined,
+  request?: operations.AppsApiRestV0ChapterListChaptersRequest | undefined,
   options?: RequestOptions,
 ): Promise<
   [
@@ -78,7 +78,8 @@ async function $do(
   const parsed = safeParse(
     request,
     (value) =>
-      operations.ListChaptersRequest$outboundSchema.optional().parse(value),
+      operations.AppsApiRestV0ChapterListChaptersRequest$outboundSchema
+        .optional().parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -108,7 +109,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "list_chapters",
+    operationID: "apps_api_rest_v0_chapter_list_chapters",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,

package/src/funcs/committeesAppsApiRestV0CommitteeGetChapter.ts

@@ -0,0 +1,179 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { NestCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { NestError } from "../models/errors/nesterror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get committee
+ *
+ * @remarks
+ * Retrieve committee details.
+ */
+export function committeesAppsApiRestV0CommitteeGetChapter(
+  client: NestCore,
+  request: operations.AppsApiRestV0CommitteeGetChapterRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.CommitteeSchema,
+    | errors.CommitteeErrorResponse
+    | NestError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: NestCore,
+  request: operations.AppsApiRestV0CommitteeGetChapterRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.CommitteeSchema,
+      | errors.CommitteeErrorResponse
+      | NestError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.AppsApiRestV0CommitteeGetChapterRequest$outboundSchema.parse(
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    committee_id: encodeSimple("committee_id", payload.committee_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/api/v0/committees/{committee_id}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyHeader);
+  const securityInput = secConfig == null ? {} : { apiKeyHeader: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "apps_api_rest_v0_committee_get_chapter",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyHeader,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["404", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    models.CommitteeSchema,
+    | errors.CommitteeErrorResponse
+    | NestError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.CommitteeSchema$inboundSchema),
+    M.jsonErr(404, errors.CommitteeErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/{communityGetMember.ts → communityAppsApiRestV0MemberGetMember.ts}

@@ -27,14 +27,14 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get member by login
+ * Get member
  *
  * @remarks
- * Retrieve a member by login.
+ * Retrieve member details.
  */
-export function communityGetMember(
+export function communityAppsApiRestV0MemberGetMember(
   client: NestCore,
-  request: operations.GetMemberRequest,
+  request: operations.AppsApiRestV0MemberGetMemberRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
@@ -59,7 +59,7 @@ export function communityGetMember(
 
 async function $do(
   client: NestCore,
-  request: operations.GetMemberRequest,
+  request: operations.AppsApiRestV0MemberGetMemberRequest,
   options?: RequestOptions,
 ): Promise<
   [
@@ -80,7 +80,10 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) => operations.GetMemberRequest$outboundSchema.parse(value),
+    (value) =>
+      operations.AppsApiRestV0MemberGetMemberRequest$outboundSchema.parse(
+        value,
+      ),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -90,13 +93,13 @@ async function $do(
   const body = null;
 
   const pathParams = {
-    login: encodeSimple("login", payload.login, {
+    member_id: encodeSimple("member_id", payload.member_id, {
       explode: false,
       charEncoding: "percent",
     }),
   };
 
-  const path = pathToFunc("/api/v0/members/{login}")(pathParams);
+  const path = pathToFunc("/api/v0/members/{member_id}")(pathParams);
 
   const headers = new Headers(compactMap({
     Accept: "application/json",
@@ -109,7 +112,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "get_member",
+    operationID: "apps_api_rest_v0_member_get_member",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,