vanta-auditor-api-sdk 0.1.1 → 0.2.0

package/src/funcs/auditorsCreate.ts

@@ -5,6 +5,7 @@
 import { VantaCore } from "../core.js";
 import { encodeJSON } 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";
@@ -19,6 +20,7 @@ import {
   UnexpectedClientError,
 } from "../models/errors/httpclienterrors.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
@@ -27,11 +29,11 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Create an auditor in Vanta.
  */
-export async function auditorsCreate(
+export function auditorsCreate(
   client: VantaCore,
   request: components.AddAuditorInput,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     components.Auditor,
     | APIError
@@ -42,6 +44,32 @@ export async function auditorsCreate(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: VantaCore,
+  request: components.AddAuditorInput,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.Auditor,
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const parsed = safeParse(
     request,
@@ -49,23 +77,24 @@ export async function auditorsCreate(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = encodeJSON("body", payload, { explode: true });
 
   const path = pathToFunc("/auditors")();
 
-  const headers = new Headers({
+  const headers = new Headers(compactMap({
     "Content-Type": "application/json",
     Accept: "application/json",
-  });
+  }));
 
   const secConfig = await extractSecurity(client._options.bearerAuth);
   const securityInput = secConfig == null ? {} : { bearerAuth: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "CreateAuditor",
     oAuth2Scopes: [],
 
@@ -88,7 +117,7 @@ export async function auditorsCreate(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -99,7 +128,7 @@ export async function auditorsCreate(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -114,11 +143,12 @@ export async function auditorsCreate(
     | ConnectionError
   >(
     M.json(200, components.Auditor$inboundSchema),
-    M.fail(["4XX", "5XX"]),
+    M.fail("4XX"),
+    M.fail("5XX"),
   )(response);
   if (!result.ok) {
-    return result;
+    return [result, { status: "complete", request: req, response }];
   }
 
-  return result;
+  return [result, { status: "complete", request: req, response }];
 }

package/src/funcs/auditsCreateCommentForEvidence.ts

@@ -5,6 +5,7 @@
 import { VantaCore } from "../core.js";
 import { encodeJSON, 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";
@@ -20,6 +21,7 @@ import {
 } from "../models/errors/httpclienterrors.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
@@ -28,11 +30,11 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Create a comment in Vanta for a piece of evidence.
  */
-export async function auditsCreateCommentForEvidence(
+export function auditsCreateCommentForEvidence(
   client: VantaCore,
   request: operations.CreateCommentForAuditEvidenceRequest,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     components.Comment,
     | APIError
@@ -43,6 +45,32 @@ export async function auditsCreateCommentForEvidence(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: VantaCore,
+  request: operations.CreateCommentForAuditEvidenceRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.Comment,
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const parsed = safeParse(
     request,
@@ -53,7 +81,7 @@ export async function auditsCreateCommentForEvidence(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = encodeJSON("body", payload.AddCommentInput, { explode: true });
@@ -73,16 +101,17 @@ export async function auditsCreateCommentForEvidence(
     "/audits/{auditId}/evidence/{auditEvidenceId}/comments",
   )(pathParams);
 
-  const headers = new Headers({
+  const headers = new Headers(compactMap({
     "Content-Type": "application/json",
     Accept: "application/json",
-  });
+  }));
 
   const secConfig = await extractSecurity(client._options.bearerAuth);
   const securityInput = secConfig == null ? {} : { bearerAuth: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "CreateCommentForAuditEvidence",
     oAuth2Scopes: [],
 
@@ -105,7 +134,7 @@ export async function auditsCreateCommentForEvidence(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -116,7 +145,7 @@ export async function auditsCreateCommentForEvidence(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -131,11 +160,12 @@ export async function auditsCreateCommentForEvidence(
     | ConnectionError
   >(
     M.json(200, components.Comment$inboundSchema),
-    M.fail(["4XX", "5XX"]),
+    M.fail("4XX"),
+    M.fail("5XX"),
   )(response);
   if (!result.ok) {
-    return result;
+    return [result, { status: "complete", request: req, response }];
   }
 
-  return result;
+  return [result, { status: "complete", request: req, response }];
 }

package/src/funcs/auditsCreateCustomControl.ts

@@ -5,6 +5,7 @@
 import { VantaCore } from "../core.js";
 import { encodeJSON, 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";
@@ -20,6 +21,7 @@ import {
 } from "../models/errors/httpclienterrors.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
@@ -28,11 +30,11 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Create a custom control for an audit.
  */
-export async function auditsCreateCustomControl(
+export function auditsCreateCustomControl(
   client: VantaCore,
   request: operations.CreateCustomControlRequest,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     components.Control,
     | APIError
@@ -43,6 +45,32 @@ export async function auditsCreateCustomControl(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: VantaCore,
+  request: operations.CreateCustomControlRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.Control,
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const parsed = safeParse(
     request,
@@ -51,7 +79,7 @@ export async function auditsCreateCustomControl(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = encodeJSON("body", payload.CreateCustomControlInput, {
@@ -69,16 +97,17 @@ export async function auditsCreateCustomControl(
     pathParams,
   );
 
-  const headers = new Headers({
+  const headers = new Headers(compactMap({
     "Content-Type": "application/json",
     Accept: "application/json",
-  });
+  }));
 
   const secConfig = await extractSecurity(client._options.bearerAuth);
   const securityInput = secConfig == null ? {} : { bearerAuth: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "CreateCustomControl",
     oAuth2Scopes: [],
 
@@ -101,7 +130,7 @@ export async function auditsCreateCustomControl(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -112,7 +141,7 @@ export async function auditsCreateCustomControl(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -127,11 +156,12 @@ export async function auditsCreateCustomControl(
     | ConnectionError
   >(
     M.json(201, components.Control$inboundSchema),
-    M.fail(["4XX", "5XX"]),
+    M.fail("4XX"),
+    M.fail("5XX"),
   )(response);
   if (!result.ok) {
-    return result;
+    return [result, { status: "complete", request: req, response }];
   }
 
-  return result;
+  return [result, { status: "complete", request: req, response }];
 }

package/src/funcs/auditsCreateCustomEvidenceRequest.ts

@@ -5,6 +5,7 @@
 import { VantaCore } from "../core.js";
 import { encodeJSON, 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";
@@ -20,6 +21,7 @@ import {
 } from "../models/errors/httpclienterrors.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
@@ -28,11 +30,11 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Create a custom evidence request for an audit.
  */
-export async function auditsCreateCustomEvidenceRequest(
+export function auditsCreateCustomEvidenceRequest(
   client: VantaCore,
   request: operations.CreateCustomEvidenceRequestRequest,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     components.CustomEvidenceRequest,
     | APIError
@@ -43,6 +45,32 @@ export async function auditsCreateCustomEvidenceRequest(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: VantaCore,
+  request: operations.CreateCustomEvidenceRequestRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.CustomEvidenceRequest,
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const parsed = safeParse(
     request,
@@ -51,7 +79,7 @@ export async function auditsCreateCustomEvidenceRequest(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = encodeJSON("body", payload.CreateCustomEvidenceRequestInput, {
@@ -69,16 +97,17 @@ export async function auditsCreateCustomEvidenceRequest(
     "/audits/{auditId}/evidence/custom-evidence-requests",
   )(pathParams);
 
-  const headers = new Headers({
+  const headers = new Headers(compactMap({
     "Content-Type": "application/json",
     Accept: "application/json",
-  });
+  }));
 
   const secConfig = await extractSecurity(client._options.bearerAuth);
   const securityInput = secConfig == null ? {} : { bearerAuth: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "CreateCustomEvidenceRequest",
     oAuth2Scopes: [],
 
@@ -101,7 +130,7 @@ export async function auditsCreateCustomEvidenceRequest(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -112,7 +141,7 @@ export async function auditsCreateCustomEvidenceRequest(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -127,11 +156,12 @@ export async function auditsCreateCustomEvidenceRequest(
     | ConnectionError
   >(
     M.json(200, components.CustomEvidenceRequest$inboundSchema),
-    M.fail(["4XX", "5XX"]),
+    M.fail("4XX"),
+    M.fail("5XX"),
   )(response);
   if (!result.ok) {
-    return result;
+    return [result, { status: "complete", request: req, response }];
   }
 
-  return result;
+  return [result, { status: "complete", request: req, response }];
 }

package/src/funcs/auditsGetEvidenceUrls.ts

@@ -5,6 +5,7 @@
 import { VantaCore } from "../core.js";
 import { encodeFormQuery, 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";
@@ -20,19 +21,21 @@ import {
 } from "../models/errors/httpclienterrors.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
  * List audit evidence url
  *
  * @remarks
- * Returns a paginated list of evidence urls for an audit.
+ * Returns a paginated list of evidence urls for an audit. This endpoint should be called whenever an
+ * evidence is created or has a statusUpdatedAt field that is more recent than the most recent polling event.
  */
-export async function auditsGetEvidenceUrls(
+export function auditsGetEvidenceUrls(
   client: VantaCore,
   request: operations.ListAuditEvidenceUrlsRequest,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     components.PaginatedResponseEvidenceUrl,
     | APIError
@@ -43,6 +46,32 @@ export async function auditsGetEvidenceUrls(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: VantaCore,
+  request: operations.ListAuditEvidenceUrlsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.PaginatedResponseEvidenceUrl,
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const parsed = safeParse(
     request,
@@ -51,7 +80,7 @@ export async function auditsGetEvidenceUrls(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = null;
@@ -76,15 +105,16 @@ export async function auditsGetEvidenceUrls(
     "pageSize": payload.pageSize,
   });
 
-  const headers = new Headers({
+  const headers = new Headers(compactMap({
     Accept: "application/json",
-  });
+  }));
 
   const secConfig = await extractSecurity(client._options.bearerAuth);
   const securityInput = secConfig == null ? {} : { bearerAuth: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "ListAuditEvidenceUrls",
     oAuth2Scopes: [],
 
@@ -108,7 +138,7 @@ export async function auditsGetEvidenceUrls(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -119,7 +149,7 @@ export async function auditsGetEvidenceUrls(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -134,11 +164,12 @@ export async function auditsGetEvidenceUrls(
     | ConnectionError
   >(
     M.json(200, components.PaginatedResponseEvidenceUrl$inboundSchema),
-    M.fail(["4XX", "5XX"]),
+    M.fail("4XX"),
+    M.fail("5XX"),
   )(response);
   if (!result.ok) {
-    return result;
+    return [result, { status: "complete", request: req, response }];
   }
 
-  return result;
+  return [result, { status: "complete", request: req, response }];
 }