owasp-nest 0.2.1 → 0.2.3

package/src/funcs/sponsorsListSponsors.ts

@@ -0,0 +1,171 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { NestCore } from "../core.js";
+import { encodeFormQuery } 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 { 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";
+
+/**
+ * List sponsors
+ *
+ * @remarks
+ * Retrieve a paginated list of OWASP sponsors.
+ */
+export function sponsorsListSponsors(
+  client: NestCore,
+  request?: operations.ListSponsorsRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.PagedSponsorSchema,
+    | NestError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: NestCore,
+  request?: operations.ListSponsorsRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.PagedSponsorSchema,
+      | NestError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.ListSponsorsRequest$outboundSchema.optional().parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/api/v0/sponsors/")();
+
+  const query = encodeFormQuery({
+    "is_member": payload?.is_member,
+    "member_type": payload?.member_type,
+    "ordering": payload?.ordering,
+    "page": payload?.page,
+    "page_size": payload?.page_size,
+    "sponsor_type": payload?.sponsor_type,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "list_sponsors",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    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,
+    query: query,
+    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: ["4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    models.PagedSponsorSchema,
+    | NestError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.PagedSponsorSchema$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -18,7 +18,7 @@ export const ServerList = [
 ] as const;
 
 export type SDKOptions = {
-  apiKeyHeader?: string | (() => Promise<string>) | undefined;
+  apiKey?: string | (() => Promise<string>) | undefined;
 
   httpClient?: HTTPClient;
   /**
@@ -60,8 +60,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "0.2.1",
-  sdkVersion: "0.2.1",
-  genVersion: "2.698.4",
-  userAgent: "speakeasy-sdk/typescript 0.2.1 2.698.4 0.2.1 owasp-nest",
+  openapiDocVersion: "0.2.3",
+  sdkVersion: "0.2.3",
+  genVersion: "2.707.0",
+  userAgent: "speakeasy-sdk/typescript 0.2.3 2.707.0 0.2.3 owasp-nest",
 } as const;

package/src/lib/env.ts

@@ -7,13 +7,13 @@ import { dlv } from "./dlv.js";
 import * as z from "zod";
 
 export interface Env {
-  NEST_API_KEY_HEADER?: string | undefined;
+  NEST_API_KEY?: string | undefined;
 
   NEST_DEBUG?: boolean | undefined;
 }
 
 export const envSchema: z.ZodType<Env, z.ZodTypeDef, unknown> = z.object({
-  NEST_API_KEY_HEADER: z.string().optional(),
+  NEST_API_KEY: z.string().optional(),
 
   NEST_DEBUG: z.coerce.boolean().optional(),
 });

package/src/lib/security.ts

@@ -247,7 +247,7 @@ export function resolveGlobalSecurity(
       {
         fieldName: "X-API-Key",
         type: "apiKey:header",
-        value: security?.apiKeyHeader ?? env().NEST_API_KEY_HEADER,
+        value: security?.apiKey ?? env().NEST_API_KEY,
       },
     ],
   );

package/src/models/errors/index.ts

@@ -11,3 +11,4 @@ export * from "./organizationerrorresponse.js";
 export * from "./projecterrorresponse.js";
 export * from "./responsevalidationerror.js";
 export * from "./sdkvalidationerror.js";
+export * from "./sponsorerrorresponse.js";

package/src/models/errors/sponsorerrorresponse.ts

@@ -0,0 +1,80 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { NestError } from "./nesterror.js";
+
+/**
+ * Sponsor error response schema.
+ */
+export type SponsorErrorResponseData = {
+  message: string;
+};
+
+/**
+ * Sponsor error response schema.
+ */
+export class SponsorErrorResponse extends NestError {
+  /** The original data that was passed to this error instance. */
+  data$: SponsorErrorResponseData;
+
+  constructor(
+    err: SponsorErrorResponseData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+
+    this.name = "SponsorErrorResponse";
+  }
+}
+
+/** @internal */
+export const SponsorErrorResponse$inboundSchema: z.ZodType<
+  SponsorErrorResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new SponsorErrorResponse(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type SponsorErrorResponse$Outbound = {
+  message: string;
+};
+
+/** @internal */
+export const SponsorErrorResponse$outboundSchema: z.ZodType<
+  SponsorErrorResponse$Outbound,
+  z.ZodTypeDef,
+  SponsorErrorResponse
+> = z.instanceof(SponsorErrorResponse)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    message: z.string(),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SponsorErrorResponse$ {
+  /** @deprecated use `SponsorErrorResponse$inboundSchema` instead. */
+  export const inboundSchema = SponsorErrorResponse$inboundSchema;
+  /** @deprecated use `SponsorErrorResponse$outboundSchema` instead. */
+  export const outboundSchema = SponsorErrorResponse$outboundSchema;
+  /** @deprecated use `SponsorErrorResponse$Outbound` instead. */
+  export type Outbound = SponsorErrorResponse$Outbound;
+}

package/src/models/index.ts

@@ -7,6 +7,7 @@ export * from "./committeeschema.js";
 export * from "./eventschema.js";
 export * from "./issueschema.js";
 export * from "./memberschema.js";
+export * from "./membertype.js";
 export * from "./organizationschema.js";
 export * from "./pagedchapterschema.js";
 export * from "./pagedcommitteeschema.js";
@@ -17,9 +18,11 @@ export * from "./pagedorganizationschema.js";
 export * from "./pagedprojectschema.js";
 export * from "./pagedreleaseschema.js";
 export * from "./pagedrepositoryschema.js";
+export * from "./pagedsponsorschema.js";
 export * from "./projectlevel.js";
 export * from "./projectschema.js";
 export * from "./releaseschema.js";
 export * from "./repositoryschema.js";
 export * from "./security.js";
+export * from "./sponsorschema.js";
 export * from "./state.js";

package/src/models/membertype.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
+
+export const MemberType = {
+  Platinum: "Platinum",
+  Gold: "Gold",
+  Silver: "Silver",
+} as const;
+export type MemberType = ClosedEnum<typeof MemberType>;
+
+/** @internal */
+export const MemberType$inboundSchema: z.ZodNativeEnum<typeof MemberType> = z
+  .nativeEnum(MemberType);
+
+/** @internal */
+export const MemberType$outboundSchema: z.ZodNativeEnum<typeof MemberType> =
+  MemberType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MemberType$ {
+  /** @deprecated use `MemberType$inboundSchema` instead. */
+  export const inboundSchema = MemberType$inboundSchema;
+  /** @deprecated use `MemberType$outboundSchema` instead. */
+  export const outboundSchema = MemberType$outboundSchema;
+}

package/src/models/operations/getchapter.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetChapterRequest = {
+  chapterId: string;
+};
+
+/** @internal */
+export const GetChapterRequest$inboundSchema: z.ZodType<
+  GetChapterRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  chapter_id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "chapter_id": "chapterId",
+  });
+});
+
+/** @internal */
+export type GetChapterRequest$Outbound = {
+  chapter_id: string;
+};
+
+/** @internal */
+export const GetChapterRequest$outboundSchema: z.ZodType<
+  GetChapterRequest$Outbound,
+  z.ZodTypeDef,
+  GetChapterRequest
+> = z.object({
+  chapterId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    chapterId: "chapter_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetChapterRequest$ {
+  /** @deprecated use `GetChapterRequest$inboundSchema` instead. */
+  export const inboundSchema = GetChapterRequest$inboundSchema;
+  /** @deprecated use `GetChapterRequest$outboundSchema` instead. */
+  export const outboundSchema = GetChapterRequest$outboundSchema;
+  /** @deprecated use `GetChapterRequest$Outbound` instead. */
+  export type Outbound = GetChapterRequest$Outbound;
+}
+
+export function getChapterRequestToJSON(
+  getChapterRequest: GetChapterRequest,
+): string {
+  return JSON.stringify(
+    GetChapterRequest$outboundSchema.parse(getChapterRequest),
+  );
+}
+
+export function getChapterRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetChapterRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetChapterRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetChapterRequest' from JSON`,
+  );
+}

package/src/models/operations/getcommittee.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetCommitteeRequest = {
+  committeeId: string;
+};
+
+/** @internal */
+export const GetCommitteeRequest$inboundSchema: z.ZodType<
+  GetCommitteeRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  committee_id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "committee_id": "committeeId",
+  });
+});
+
+/** @internal */
+export type GetCommitteeRequest$Outbound = {
+  committee_id: string;
+};
+
+/** @internal */
+export const GetCommitteeRequest$outboundSchema: z.ZodType<
+  GetCommitteeRequest$Outbound,
+  z.ZodTypeDef,
+  GetCommitteeRequest
+> = z.object({
+  committeeId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    committeeId: "committee_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetCommitteeRequest$ {
+  /** @deprecated use `GetCommitteeRequest$inboundSchema` instead. */
+  export const inboundSchema = GetCommitteeRequest$inboundSchema;
+  /** @deprecated use `GetCommitteeRequest$outboundSchema` instead. */
+  export const outboundSchema = GetCommitteeRequest$outboundSchema;
+  /** @deprecated use `GetCommitteeRequest$Outbound` instead. */
+  export type Outbound = GetCommitteeRequest$Outbound;
+}
+
+export function getCommitteeRequestToJSON(
+  getCommitteeRequest: GetCommitteeRequest,
+): string {
+  return JSON.stringify(
+    GetCommitteeRequest$outboundSchema.parse(getCommitteeRequest),
+  );
+}
+
+export function getCommitteeRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCommitteeRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCommitteeRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCommitteeRequest' from JSON`,
+  );
+}

package/src/models/operations/getmember.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetMemberRequest = {
+  memberId: string;
+};
+
+/** @internal */
+export const GetMemberRequest$inboundSchema: z.ZodType<
+  GetMemberRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  member_id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "member_id": "memberId",
+  });
+});
+
+/** @internal */
+export type GetMemberRequest$Outbound = {
+  member_id: string;
+};
+
+/** @internal */
+export const GetMemberRequest$outboundSchema: z.ZodType<
+  GetMemberRequest$Outbound,
+  z.ZodTypeDef,
+  GetMemberRequest
+> = z.object({
+  memberId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    memberId: "member_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetMemberRequest$ {
+  /** @deprecated use `GetMemberRequest$inboundSchema` instead. */
+  export const inboundSchema = GetMemberRequest$inboundSchema;
+  /** @deprecated use `GetMemberRequest$outboundSchema` instead. */
+  export const outboundSchema = GetMemberRequest$outboundSchema;
+  /** @deprecated use `GetMemberRequest$Outbound` instead. */
+  export type Outbound = GetMemberRequest$Outbound;
+}
+
+export function getMemberRequestToJSON(
+  getMemberRequest: GetMemberRequest,
+): string {
+  return JSON.stringify(
+    GetMemberRequest$outboundSchema.parse(getMemberRequest),
+  );
+}
+
+export function getMemberRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetMemberRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetMemberRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetMemberRequest' from JSON`,
+  );
+}

package/src/models/operations/getorganization.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetOrganizationRequest = {
+  organizationId: string;
+};
+
+/** @internal */
+export const GetOrganizationRequest$inboundSchema: z.ZodType<
+  GetOrganizationRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  organization_id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "organization_id": "organizationId",
+  });
+});
+
+/** @internal */
+export type GetOrganizationRequest$Outbound = {
+  organization_id: string;
+};
+
+/** @internal */
+export const GetOrganizationRequest$outboundSchema: z.ZodType<
+  GetOrganizationRequest$Outbound,
+  z.ZodTypeDef,
+  GetOrganizationRequest
+> = z.object({
+  organizationId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    organizationId: "organization_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetOrganizationRequest$ {
+  /** @deprecated use `GetOrganizationRequest$inboundSchema` instead. */
+  export const inboundSchema = GetOrganizationRequest$inboundSchema;
+  /** @deprecated use `GetOrganizationRequest$outboundSchema` instead. */
+  export const outboundSchema = GetOrganizationRequest$outboundSchema;
+  /** @deprecated use `GetOrganizationRequest$Outbound` instead. */
+  export type Outbound = GetOrganizationRequest$Outbound;
+}
+
+export function getOrganizationRequestToJSON(
+  getOrganizationRequest: GetOrganizationRequest,
+): string {
+  return JSON.stringify(
+    GetOrganizationRequest$outboundSchema.parse(getOrganizationRequest),
+  );
+}
+
+export function getOrganizationRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetOrganizationRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetOrganizationRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetOrganizationRequest' from JSON`,
+  );
+}