@documenso/sdk-typescript 0.2.0 → 0.3.0

package/docs/sdks/embedding/README.md

@@ -0,0 +1,153 @@
+# Embedding
+(*embedding*)
+
+## Overview
+
+### Available Operations
+
+* [embeddingPresignCreateEmbeddingPresignToken](#embeddingpresigncreateembeddingpresigntoken) - Create embedding presign token
+* [embeddingPresignVerifyEmbeddingPresignToken](#embeddingpresignverifyembeddingpresigntoken) - Verify embedding presign token
+
+## embeddingPresignCreateEmbeddingPresignToken
+
+Creates a presign token for embedding operations with configurable expiration time
+
+### Example Usage
+
+```typescript
+import { Documenso } from "@documenso/sdk-typescript";
+
+const documenso = new Documenso({
+  apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await documenso.embedding.embeddingPresignCreateEmbeddingPresignToken({});
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
+import { embeddingEmbeddingPresignCreateEmbeddingPresignToken } from "@documenso/sdk-typescript/funcs/embeddingEmbeddingPresignCreateEmbeddingPresignToken.js";
+
+// Use `DocumensoCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const documenso = new DocumensoCore({
+  apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await embeddingEmbeddingPresignCreateEmbeddingPresignToken(documenso, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("embeddingEmbeddingPresignCreateEmbeddingPresignToken failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.EmbeddingPresignCreateEmbeddingPresignTokenRequest](../../models/operations/embeddingpresigncreateembeddingpresigntokenrequest.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\<[operations.EmbeddingPresignCreateEmbeddingPresignTokenResponse](../../models/operations/embeddingpresigncreateembeddingpresigntokenresponse.md)\>**
+
+### Errors
+
+| Error Type                                                            | Status Code                                                           | Content Type                                                          |
+| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| errors.EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError     | 400                                                                   | application/json                                                      |
+| errors.EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError | 500                                                                   | application/json                                                      |
+| errors.APIError                                                       | 4XX, 5XX                                                              | \*/\*                                                                 |
+
+## embeddingPresignVerifyEmbeddingPresignToken
+
+Verifies a presign token for embedding operations and returns the associated API token
+
+### Example Usage
+
+```typescript
+import { Documenso } from "@documenso/sdk-typescript";
+
+const documenso = new Documenso({
+  apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await documenso.embedding.embeddingPresignVerifyEmbeddingPresignToken({
+    token: "<value>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
+import { embeddingEmbeddingPresignVerifyEmbeddingPresignToken } from "@documenso/sdk-typescript/funcs/embeddingEmbeddingPresignVerifyEmbeddingPresignToken.js";
+
+// Use `DocumensoCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const documenso = new DocumensoCore({
+  apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await embeddingEmbeddingPresignVerifyEmbeddingPresignToken(documenso, {
+    token: "<value>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("embeddingEmbeddingPresignVerifyEmbeddingPresignToken failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.EmbeddingPresignVerifyEmbeddingPresignTokenRequest](../../models/operations/embeddingpresignverifyembeddingpresigntokenrequest.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\<[operations.EmbeddingPresignVerifyEmbeddingPresignTokenResponse](../../models/operations/embeddingpresignverifyembeddingpresigntokenresponse.md)\>**
+
+### Errors
+
+| Error Type                                                            | Status Code                                                           | Content Type                                                          |
+| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| errors.EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError     | 400                                                                   | application/json                                                      |
+| errors.EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError | 500                                                                   | application/json                                                      |
+| errors.APIError                                                       | 4XX, 5XX                                                              | \*/\*                                                                 |

package/docs/sdks/templates/README.md

@@ -29,7 +29,6 @@ const documenso = new Documenso({
 async function run() {
   const result = await documenso.templates.find({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -52,15 +51,12 @@ const documenso = new DocumensoCore({
 
 async function run() {
   const res = await templatesFind(documenso, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("templatesFind failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -103,10 +99,9 @@ const documenso = new Documenso({
 
 async function run() {
   const result = await documenso.templates.get({
-    templateId: 7003.47,
+    templateId: 2128.54,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -129,17 +124,14 @@ const documenso = new DocumensoCore({
 
 async function run() {
   const res = await templatesGet(documenso, {
-    templateId: 7003.47,
+    templateId: 2128.54,
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("templatesGet failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -182,10 +174,9 @@ const documenso = new Documenso({
 
 async function run() {
   const result = await documenso.templates.update({
-    templateId: 8574.78,
+    templateId: 9404.77,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -208,17 +199,14 @@ const documenso = new DocumensoCore({
 
 async function run() {
   const res = await templatesUpdate(documenso, {
-    templateId: 8574.78,
+    templateId: 9404.77,
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("templatesUpdate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -260,10 +248,9 @@ const documenso = new Documenso({
 
 async function run() {
   const result = await documenso.templates.duplicate({
-    templateId: 3523.11,
+    templateId: 2490.16,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -286,17 +273,14 @@ const documenso = new DocumensoCore({
 
 async function run() {
   const res = await templatesDuplicate(documenso, {
-    templateId: 3523.11,
+    templateId: 2490.16,
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("templatesDuplicate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -338,10 +322,9 @@ const documenso = new Documenso({
 
 async function run() {
   const result = await documenso.templates.delete({
-    templateId: 5459.07,
+    templateId: 536.89,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -364,17 +347,14 @@ const documenso = new DocumensoCore({
 
 async function run() {
   const res = await templatesDelete(documenso, {
-    templateId: 5459.07,
+    templateId: 536.89,
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("templatesDelete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -416,20 +396,10 @@ const documenso = new Documenso({
 
 async function run() {
   const result = await documenso.templates.use({
-    templateId: 6626.9,
-    recipients: [
-      {
-        id: 6473.53,
-        email: "August_Schmeler68@yahoo.com",
-      },
-      {
-        id: 3772.31,
-        email: "Angeline.Purdy@gmail.com",
-      },
-    ],
+    templateId: 7392.96,
+    recipients: [],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -452,27 +422,15 @@ const documenso = new DocumensoCore({
 
 async function run() {
   const res = await templatesUse(documenso, {
-    templateId: 6626.9,
-    recipients: [
-      {
-        id: 6473.53,
-        email: "August_Schmeler68@yahoo.com",
-      },
-      {
-        id: 3772.31,
-        email: "Angeline.Purdy@gmail.com",
-      },
-    ],
+    templateId: 7392.96,
+    recipients: [],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("templatesUse failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -514,11 +472,10 @@ const documenso = new Documenso({
 
 async function run() {
   const result = await documenso.templates.moveToTeam({
-    templateId: 8301.72,
-    teamId: 6724.78,
+    templateId: 9124,
+    teamId: 6200.73,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -541,18 +498,15 @@ const documenso = new DocumensoCore({
 
 async function run() {
   const res = await templatesMoveToTeam(documenso, {
-    templateId: 8301.72,
-    teamId: 6724.78,
+    templateId: 9124,
+    teamId: 6200.73,
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("templatesMoveToTeam failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();