@documenso/sdk-typescript 0.8.0 → 0.9.0

package/src/funcs/envelopeEnvelopeAuditLogDownloadPdf.ts

@@ -0,0 +1,213 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { DocumensoCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.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 { DocumensoError } from "../models/errors/documensoerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.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";
+
+/**
+ * Download envelope audit log PDF
+ *
+ * @remarks
+ * Download the audit log for a document as a PDF.
+ */
+export function envelopeEnvelopeAuditLogDownloadPdf(
+  client: DocumensoCore,
+  request: operations.EnvelopeAuditLogDownloadPdfRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.EnvelopeAuditLogDownloadPdfResponse,
+    | errors.EnvelopeAuditLogDownloadPdfBadRequestError
+    | errors.EnvelopeAuditLogDownloadPdfUnauthorizedError
+    | errors.EnvelopeAuditLogDownloadPdfForbiddenError
+    | errors.EnvelopeAuditLogDownloadPdfNotFoundError
+    | errors.EnvelopeAuditLogDownloadPdfInternalServerError
+    | DocumensoError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: DocumensoCore,
+  request: operations.EnvelopeAuditLogDownloadPdfRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.EnvelopeAuditLogDownloadPdfResponse,
+      | errors.EnvelopeAuditLogDownloadPdfBadRequestError
+      | errors.EnvelopeAuditLogDownloadPdfUnauthorizedError
+      | errors.EnvelopeAuditLogDownloadPdfForbiddenError
+      | errors.EnvelopeAuditLogDownloadPdfNotFoundError
+      | errors.EnvelopeAuditLogDownloadPdfInternalServerError
+      | DocumensoError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.EnvelopeAuditLogDownloadPdfRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    envelopeId: encodeSimple("envelopeId", payload.envelopeId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/envelope/{envelopeId}/audit-log/download")(
+    pathParams,
+  );
+
+  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: "envelope-auditLog-downloadPdf",
+    oAuth2Scopes: null,
+
+    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,
+    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,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["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<
+    operations.EnvelopeAuditLogDownloadPdfResponse,
+    | errors.EnvelopeAuditLogDownloadPdfBadRequestError
+    | errors.EnvelopeAuditLogDownloadPdfUnauthorizedError
+    | errors.EnvelopeAuditLogDownloadPdfForbiddenError
+    | errors.EnvelopeAuditLogDownloadPdfNotFoundError
+    | errors.EnvelopeAuditLogDownloadPdfInternalServerError
+    | DocumensoError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.EnvelopeAuditLogDownloadPdfResponse$inboundSchema, {
+      hdrs: true,
+      key: "Result",
+    }),
+    M.jsonErr(
+      400,
+      errors.EnvelopeAuditLogDownloadPdfBadRequestError$inboundSchema,
+    ),
+    M.jsonErr(
+      401,
+      errors.EnvelopeAuditLogDownloadPdfUnauthorizedError$inboundSchema,
+    ),
+    M.jsonErr(
+      403,
+      errors.EnvelopeAuditLogDownloadPdfForbiddenError$inboundSchema,
+    ),
+    M.jsonErr(
+      404,
+      errors.EnvelopeAuditLogDownloadPdfNotFoundError$inboundSchema,
+    ),
+    M.jsonErr(
+      500,
+      errors.EnvelopeAuditLogDownloadPdfInternalServerError$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/envelopeEnvelopeAuditLogFind.ts

@@ -4,6 +4,7 @@
 
 import { DocumensoCore } from "../core.js";
 import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
@@ -103,7 +104,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/envelope/{envelopeId}/audit-log")(pathParams);
 
   const query = encodeFormQuery({
@@ -154,7 +154,8 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["400", "401", "403", "404", "4XX", "500", "5XX"],
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });

package/src/funcs/envelopeEnvelopeCancel.ts

@@ -0,0 +1,180 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { DocumensoCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.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 { DocumensoError } from "../models/errors/documensoerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.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";
+
+/**
+ * Cancel envelope
+ */
+export function envelopeEnvelopeCancel(
+  client: DocumensoCore,
+  request: operations.EnvelopeCancelRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.EnvelopeCancelResponse,
+    | errors.EnvelopeCancelBadRequestError
+    | errors.EnvelopeCancelUnauthorizedError
+    | errors.EnvelopeCancelForbiddenError
+    | errors.EnvelopeCancelInternalServerError
+    | DocumensoError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: DocumensoCore,
+  request: operations.EnvelopeCancelRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.EnvelopeCancelResponse,
+      | errors.EnvelopeCancelBadRequestError
+      | errors.EnvelopeCancelUnauthorizedError
+      | errors.EnvelopeCancelForbiddenError
+      | errors.EnvelopeCancelInternalServerError
+      | DocumensoError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.EnvelopeCancelRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/envelope/cancel")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    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: "envelope-cancel",
+    oAuth2Scopes: null,
+
+    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: "POST",
+    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,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["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<
+    operations.EnvelopeCancelResponse,
+    | errors.EnvelopeCancelBadRequestError
+    | errors.EnvelopeCancelUnauthorizedError
+    | errors.EnvelopeCancelForbiddenError
+    | errors.EnvelopeCancelInternalServerError
+    | DocumensoError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.EnvelopeCancelResponse$inboundSchema),
+    M.jsonErr(400, errors.EnvelopeCancelBadRequestError$inboundSchema),
+    M.jsonErr(401, errors.EnvelopeCancelUnauthorizedError$inboundSchema),
+    M.jsonErr(403, errors.EnvelopeCancelForbiddenError$inboundSchema),
+    M.jsonErr(500, errors.EnvelopeCancelInternalServerError$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/envelopeEnvelopeCertificateDownloadPdf.ts

@@ -0,0 +1,216 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { DocumensoCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.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 { DocumensoError } from "../models/errors/documensoerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.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";
+
+/**
+ * Download envelope certificate PDF
+ *
+ * @remarks
+ * Download the signing certificate for a completed document as a PDF.
+ */
+export function envelopeEnvelopeCertificateDownloadPdf(
+  client: DocumensoCore,
+  request: operations.EnvelopeCertificateDownloadPdfRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.EnvelopeCertificateDownloadPdfResponse,
+    | errors.EnvelopeCertificateDownloadPdfBadRequestError
+    | errors.EnvelopeCertificateDownloadPdfUnauthorizedError
+    | errors.EnvelopeCertificateDownloadPdfForbiddenError
+    | errors.EnvelopeCertificateDownloadPdfNotFoundError
+    | errors.EnvelopeCertificateDownloadPdfInternalServerError
+    | DocumensoError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: DocumensoCore,
+  request: operations.EnvelopeCertificateDownloadPdfRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.EnvelopeCertificateDownloadPdfResponse,
+      | errors.EnvelopeCertificateDownloadPdfBadRequestError
+      | errors.EnvelopeCertificateDownloadPdfUnauthorizedError
+      | errors.EnvelopeCertificateDownloadPdfForbiddenError
+      | errors.EnvelopeCertificateDownloadPdfNotFoundError
+      | errors.EnvelopeCertificateDownloadPdfInternalServerError
+      | DocumensoError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.EnvelopeCertificateDownloadPdfRequest$outboundSchema.parse(
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    envelopeId: encodeSimple("envelopeId", payload.envelopeId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/envelope/{envelopeId}/certificate/download")(
+    pathParams,
+  );
+
+  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: "envelope-certificate-downloadPdf",
+    oAuth2Scopes: null,
+
+    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,
+    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,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["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<
+    operations.EnvelopeCertificateDownloadPdfResponse,
+    | errors.EnvelopeCertificateDownloadPdfBadRequestError
+    | errors.EnvelopeCertificateDownloadPdfUnauthorizedError
+    | errors.EnvelopeCertificateDownloadPdfForbiddenError
+    | errors.EnvelopeCertificateDownloadPdfNotFoundError
+    | errors.EnvelopeCertificateDownloadPdfInternalServerError
+    | DocumensoError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations.EnvelopeCertificateDownloadPdfResponse$inboundSchema,
+      { hdrs: true, key: "Result" },
+    ),
+    M.jsonErr(
+      400,
+      errors.EnvelopeCertificateDownloadPdfBadRequestError$inboundSchema,
+    ),
+    M.jsonErr(
+      401,
+      errors.EnvelopeCertificateDownloadPdfUnauthorizedError$inboundSchema,
+    ),
+    M.jsonErr(
+      403,
+      errors.EnvelopeCertificateDownloadPdfForbiddenError$inboundSchema,
+    ),
+    M.jsonErr(
+      404,
+      errors.EnvelopeCertificateDownloadPdfNotFoundError$inboundSchema,
+    ),
+    M.jsonErr(
+      500,
+      errors.EnvelopeCertificateDownloadPdfInternalServerError$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/envelopeEnvelopeFind.ts

@@ -4,6 +4,7 @@
 
 import { DocumensoCore } from "../core.js";
 import { encodeFormQuery } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
@@ -152,7 +153,8 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["400", "401", "403", "404", "4XX", "500", "5XX"],
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });

package/src/funcs/envelopeEnvelopeGetMany.ts

@@ -4,6 +4,7 @@
 
 import { DocumensoCore } from "../core.js";
 import { encodeJSON } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
@@ -137,7 +138,8 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["400", "401", "403", "4XX", "500", "5XX"],
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });