@documenso/sdk-typescript 0.3.1 → 0.4.0

package/src/funcs/documentDocumentDownload.ts

@@ -0,0 +1,188 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { DocumensoCore } 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";
+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 document (beta)
+ *
+ * @remarks
+ * Get a pre-signed download URL for the original or signed version of a document
+ */
+export function documentDocumentDownload(
+  client: DocumensoCore,
+  request: operations.DocumentDownloadRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.DocumentDownloadResponse,
+    | errors.DocumentDownloadBadRequestError
+    | errors.DocumentDownloadNotFoundError
+    | errors.DocumentDownloadInternalServerError
+    | DocumensoError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: DocumensoCore,
+  request: operations.DocumentDownloadRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.DocumentDownloadResponse,
+      | errors.DocumentDownloadBadRequestError
+      | errors.DocumentDownloadNotFoundError
+      | errors.DocumentDownloadInternalServerError
+      | DocumensoError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.DocumentDownloadRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    documentId: encodeSimple("documentId", payload.documentId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/document/{documentId}/download-beta")(pathParams);
+
+  const query = encodeFormQuery({
+    "version": payload.version,
+  });
+
+  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: "document-download",
+    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,
+    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: ["400", "404", "4XX", "500", "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.DocumentDownloadResponse,
+    | errors.DocumentDownloadBadRequestError
+    | errors.DocumentDownloadNotFoundError
+    | errors.DocumentDownloadInternalServerError
+    | DocumensoError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.DocumentDownloadResponse$inboundSchema),
+    M.jsonErr(400, errors.DocumentDownloadBadRequestError$inboundSchema),
+    M.jsonErr(404, errors.DocumentDownloadNotFoundError$inboundSchema),
+    M.jsonErr(500, errors.DocumentDownloadInternalServerError$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/documentsCreateV0.ts

@@ -108,7 +108,7 @@ async function $do(
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "document-createDocumentTemporary",
-    oAuth2Scopes: [],
+    oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
 

package/src/funcs/documentsDelete.ts

@@ -30,13 +30,13 @@ import { Result } from "../types/fp.js";
  */
 export function documentsDelete(
   client: DocumensoCore,
-  request: operations.DocumentDeleteDocumentRequest,
+  request: operations.DocumentDeleteRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.DocumentDeleteDocumentResponse,
-    | errors.DocumentDeleteDocumentBadRequestError
-    | errors.DocumentDeleteDocumentInternalServerError
+    operations.DocumentDeleteResponse,
+    | errors.DocumentDeleteBadRequestError
+    | errors.DocumentDeleteInternalServerError
     | DocumensoError
     | ResponseValidationError
     | ConnectionError
@@ -56,14 +56,14 @@ export function documentsDelete(
 
 async function $do(
   client: DocumensoCore,
-  request: operations.DocumentDeleteDocumentRequest,
+  request: operations.DocumentDeleteRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.DocumentDeleteDocumentResponse,
-      | errors.DocumentDeleteDocumentBadRequestError
-      | errors.DocumentDeleteDocumentInternalServerError
+      operations.DocumentDeleteResponse,
+      | errors.DocumentDeleteBadRequestError
+      | errors.DocumentDeleteInternalServerError
       | DocumensoError
       | ResponseValidationError
       | ConnectionError
@@ -78,8 +78,7 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) =>
-      operations.DocumentDeleteDocumentRequest$outboundSchema.parse(value),
+    (value) => operations.DocumentDeleteRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -102,8 +101,8 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "document-deleteDocument",
-    oAuth2Scopes: [],
+    operationID: "document-delete",
+    oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
 
@@ -145,9 +144,9 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.DocumentDeleteDocumentResponse,
-    | errors.DocumentDeleteDocumentBadRequestError
-    | errors.DocumentDeleteDocumentInternalServerError
+    operations.DocumentDeleteResponse,
+    | errors.DocumentDeleteBadRequestError
+    | errors.DocumentDeleteInternalServerError
     | DocumensoError
     | ResponseValidationError
     | ConnectionError
@@ -157,12 +156,9 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.DocumentDeleteDocumentResponse$inboundSchema),
-    M.jsonErr(400, errors.DocumentDeleteDocumentBadRequestError$inboundSchema),
-    M.jsonErr(
-      500,
-      errors.DocumentDeleteDocumentInternalServerError$inboundSchema,
-    ),
+    M.json(200, operations.DocumentDeleteResponse$inboundSchema),
+    M.jsonErr(400, errors.DocumentDeleteBadRequestError$inboundSchema),
+    M.jsonErr(500, errors.DocumentDeleteInternalServerError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/funcs/documentsDistribute.ts

@@ -33,13 +33,13 @@ import { Result } from "../types/fp.js";
  */
 export function documentsDistribute(
   client: DocumensoCore,
-  request: operations.DocumentSendDocumentRequest,
+  request: operations.DocumentDistributeRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.DocumentSendDocumentResponse,
-    | errors.DocumentSendDocumentBadRequestError
-    | errors.DocumentSendDocumentInternalServerError
+    operations.DocumentDistributeResponse,
+    | errors.DocumentDistributeBadRequestError
+    | errors.DocumentDistributeInternalServerError
     | DocumensoError
     | ResponseValidationError
     | ConnectionError
@@ -59,14 +59,14 @@ export function documentsDistribute(
 
 async function $do(
   client: DocumensoCore,
-  request: operations.DocumentSendDocumentRequest,
+  request: operations.DocumentDistributeRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.DocumentSendDocumentResponse,
-      | errors.DocumentSendDocumentBadRequestError
-      | errors.DocumentSendDocumentInternalServerError
+      operations.DocumentDistributeResponse,
+      | errors.DocumentDistributeBadRequestError
+      | errors.DocumentDistributeInternalServerError
       | DocumensoError
       | ResponseValidationError
       | ConnectionError
@@ -81,8 +81,7 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) =>
-      operations.DocumentSendDocumentRequest$outboundSchema.parse(value),
+    (value) => operations.DocumentDistributeRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -105,8 +104,8 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "document-sendDocument",
-    oAuth2Scopes: [],
+    operationID: "document-distribute",
+    oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
 
@@ -148,9 +147,9 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.DocumentSendDocumentResponse,
-    | errors.DocumentSendDocumentBadRequestError
-    | errors.DocumentSendDocumentInternalServerError
+    operations.DocumentDistributeResponse,
+    | errors.DocumentDistributeBadRequestError
+    | errors.DocumentDistributeInternalServerError
     | DocumensoError
     | ResponseValidationError
     | ConnectionError
@@ -160,12 +159,9 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.DocumentSendDocumentResponse$inboundSchema),
-    M.jsonErr(400, errors.DocumentSendDocumentBadRequestError$inboundSchema),
-    M.jsonErr(
-      500,
-      errors.DocumentSendDocumentInternalServerError$inboundSchema,
-    ),
+    M.json(200, operations.DocumentDistributeResponse$inboundSchema),
+    M.jsonErr(400, errors.DocumentDistributeBadRequestError$inboundSchema),
+    M.jsonErr(500, errors.DocumentDistributeInternalServerError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/funcs/documentsDuplicate.ts

@@ -30,13 +30,13 @@ import { Result } from "../types/fp.js";
  */
 export function documentsDuplicate(
   client: DocumensoCore,
-  request: operations.DocumentDuplicateDocumentRequest,
+  request: operations.DocumentDuplicateRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.DocumentDuplicateDocumentResponse,
-    | errors.DocumentDuplicateDocumentBadRequestError
-    | errors.DocumentDuplicateDocumentInternalServerError
+    operations.DocumentDuplicateResponse,
+    | errors.DocumentDuplicateBadRequestError
+    | errors.DocumentDuplicateInternalServerError
     | DocumensoError
     | ResponseValidationError
     | ConnectionError
@@ -56,14 +56,14 @@ export function documentsDuplicate(
 
 async function $do(
   client: DocumensoCore,
-  request: operations.DocumentDuplicateDocumentRequest,
+  request: operations.DocumentDuplicateRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.DocumentDuplicateDocumentResponse,
-      | errors.DocumentDuplicateDocumentBadRequestError
-      | errors.DocumentDuplicateDocumentInternalServerError
+      operations.DocumentDuplicateResponse,
+      | errors.DocumentDuplicateBadRequestError
+      | errors.DocumentDuplicateInternalServerError
       | DocumensoError
       | ResponseValidationError
       | ConnectionError
@@ -78,8 +78,7 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) =>
-      operations.DocumentDuplicateDocumentRequest$outboundSchema.parse(value),
+    (value) => operations.DocumentDuplicateRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -102,8 +101,8 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "document-duplicateDocument",
-    oAuth2Scopes: [],
+    operationID: "document-duplicate",
+    oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
 
@@ -145,9 +144,9 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.DocumentDuplicateDocumentResponse,
-    | errors.DocumentDuplicateDocumentBadRequestError
-    | errors.DocumentDuplicateDocumentInternalServerError
+    operations.DocumentDuplicateResponse,
+    | errors.DocumentDuplicateBadRequestError
+    | errors.DocumentDuplicateInternalServerError
     | DocumensoError
     | ResponseValidationError
     | ConnectionError
@@ -157,15 +156,9 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.DocumentDuplicateDocumentResponse$inboundSchema),
-    M.jsonErr(
-      400,
-      errors.DocumentDuplicateDocumentBadRequestError$inboundSchema,
-    ),
-    M.jsonErr(
-      500,
-      errors.DocumentDuplicateDocumentInternalServerError$inboundSchema,
-    ),
+    M.json(200, operations.DocumentDuplicateResponse$inboundSchema),
+    M.jsonErr(400, errors.DocumentDuplicateBadRequestError$inboundSchema),
+    M.jsonErr(500, errors.DocumentDuplicateInternalServerError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/funcs/documentsFieldsCreate.ts

@@ -106,7 +106,7 @@ async function $do(
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "field-createDocumentField",
-    oAuth2Scopes: [],
+    oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
 

package/src/funcs/documentsFieldsCreateMany.ts

@@ -106,7 +106,7 @@ async function $do(
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "field-createDocumentFields",
-    oAuth2Scopes: [],
+    oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
 

package/src/funcs/documentsFieldsDelete.ts

@@ -103,7 +103,7 @@ async function $do(
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "field-deleteDocumentField",
-    oAuth2Scopes: [],
+    oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
 

package/src/funcs/documentsFieldsGet.ts

@@ -114,7 +114,7 @@ async function $do(
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "field-getDocumentField",
-    oAuth2Scopes: [],
+    oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
 

package/src/funcs/documentsFieldsUpdate.ts

@@ -106,7 +106,7 @@ async function $do(
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "field-updateDocumentField",
-    oAuth2Scopes: [],
+    oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
 

package/src/funcs/documentsFieldsUpdateMany.ts

@@ -106,7 +106,7 @@ async function $do(
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "field-updateDocumentFields",
-    oAuth2Scopes: [],
+    oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
 

package/src/funcs/documentsFind.ts

@@ -33,14 +33,14 @@ import { Result } from "../types/fp.js";
  */
 export function documentsFind(
   client: DocumensoCore,
-  request: operations.DocumentFindDocumentsRequest,
+  request: operations.DocumentFindRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.DocumentFindDocumentsResponse,
-    | errors.DocumentFindDocumentsBadRequestError
-    | errors.DocumentFindDocumentsNotFoundError
-    | errors.DocumentFindDocumentsInternalServerError
+    operations.DocumentFindResponse,
+    | errors.DocumentFindBadRequestError
+    | errors.DocumentFindNotFoundError
+    | errors.DocumentFindInternalServerError
     | DocumensoError
     | ResponseValidationError
     | ConnectionError
@@ -60,15 +60,15 @@ export function documentsFind(
 
 async function $do(
   client: DocumensoCore,
-  request: operations.DocumentFindDocumentsRequest,
+  request: operations.DocumentFindRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.DocumentFindDocumentsResponse,
-      | errors.DocumentFindDocumentsBadRequestError
-      | errors.DocumentFindDocumentsNotFoundError
-      | errors.DocumentFindDocumentsInternalServerError
+      operations.DocumentFindResponse,
+      | errors.DocumentFindBadRequestError
+      | errors.DocumentFindNotFoundError
+      | errors.DocumentFindInternalServerError
       | DocumensoError
       | ResponseValidationError
       | ConnectionError
@@ -83,8 +83,7 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) =>
-      operations.DocumentFindDocumentsRequest$outboundSchema.parse(value),
+    (value) => operations.DocumentFindRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -118,8 +117,8 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "document-findDocuments",
-    oAuth2Scopes: [],
+    operationID: "document-find",
+    oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
 
@@ -162,10 +161,10 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.DocumentFindDocumentsResponse,
-    | errors.DocumentFindDocumentsBadRequestError
-    | errors.DocumentFindDocumentsNotFoundError
-    | errors.DocumentFindDocumentsInternalServerError
+    operations.DocumentFindResponse,
+    | errors.DocumentFindBadRequestError
+    | errors.DocumentFindNotFoundError
+    | errors.DocumentFindInternalServerError
     | DocumensoError
     | ResponseValidationError
     | ConnectionError
@@ -175,13 +174,10 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.DocumentFindDocumentsResponse$inboundSchema),
-    M.jsonErr(400, errors.DocumentFindDocumentsBadRequestError$inboundSchema),
-    M.jsonErr(404, errors.DocumentFindDocumentsNotFoundError$inboundSchema),
-    M.jsonErr(
-      500,
-      errors.DocumentFindDocumentsInternalServerError$inboundSchema,
-    ),
+    M.json(200, operations.DocumentFindResponse$inboundSchema),
+    M.jsonErr(400, errors.DocumentFindBadRequestError$inboundSchema),
+    M.jsonErr(404, errors.DocumentFindNotFoundError$inboundSchema),
+    M.jsonErr(500, errors.DocumentFindInternalServerError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });