@documenso/sdk-typescript 0.3.1 → 0.4.0

package/docs/sdks/documentsfields/README.md

@@ -18,6 +18,7 @@ Returns a single field. If you want to retrieve all the fields for a document, u
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="field-getDocumentField" method="get" path="/document/field/{fieldId}" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -93,6 +94,7 @@ Create a single field for a document.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="field-createDocumentField" method="post" path="/document/field/create" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -185,6 +187,7 @@ Create multiple fields for a document.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="field-createDocumentFields" method="post" path="/document/field/create-many" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -281,6 +284,7 @@ Update a single field for a document.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="field-updateDocumentField" method="post" path="/document/field/update" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -363,6 +367,7 @@ Update multiple fields for a document.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="field-updateDocumentFields" method="post" path="/document/field/update-many" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -439,6 +444,7 @@ Delete document field
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="field-deleteDocumentField" method="post" path="/document/field/delete" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 

package/docs/sdks/documentsrecipients/README.md

@@ -18,6 +18,7 @@ Returns a single recipient. If you want to retrieve all the recipients for a doc
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="recipient-getDocumentRecipient" method="get" path="/document/recipient/{recipientId}" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -93,6 +94,7 @@ Create a single recipient for a document.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="recipient-createDocumentRecipient" method="post" path="/document/recipient/create" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -177,6 +179,7 @@ Create multiple recipients for a document.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="recipient-createDocumentRecipients" method="post" path="/document/recipient/create-many" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -265,6 +268,7 @@ Update a single recipient for a document.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="recipient-updateDocumentRecipient" method="post" path="/document/recipient/update" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -345,6 +349,7 @@ Update multiple recipients for a document.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="recipient-updateDocumentRecipients" method="post" path="/document/recipient/update-many" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -421,6 +426,7 @@ Delete document recipient
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="recipient-deleteDocumentRecipient" method="post" path="/document/recipient/delete" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 

package/docs/sdks/embedding/README.md

@@ -14,6 +14,7 @@ Creates a presign token for embedding operations with configurable expiration ti
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="embeddingPresign-createEmbeddingPresignToken" method="post" path="/embedding/create-presign-token" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -84,6 +85,7 @@ Verifies a presign token for embedding operations and returns the associated API
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="embeddingPresign-verifyEmbeddingPresignToken" method="post" path="/embedding/verify-presign-token" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 

package/docs/sdks/template/README.md

@@ -0,0 +1,83 @@
+# Template
+(*template*)
+
+## Overview
+
+### Available Operations
+
+* [templateCreateTemplateTemporary](#templatecreatetemplatetemporary) - Create template
+
+## templateCreateTemplateTemporary
+
+You will need to upload the PDF to the provided URL returned. Note: Once V2 API is released, this will be removed since we will allow direct uploads, instead of using an upload URL.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="template-createTemplateTemporary" method="post" path="/template/create/beta" -->
+```typescript
+import { Documenso } from "@documenso/sdk-typescript";
+
+const documenso = new Documenso({
+  apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await documenso.template.templateCreateTemplateTemporary({
+    title: "<value>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
+import { templateTemplateCreateTemplateTemporary } from "@documenso/sdk-typescript/funcs/templateTemplateCreateTemplateTemporary.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 templateTemplateCreateTemplateTemporary(documenso, {
+    title: "<value>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("templateTemplateCreateTemplateTemporary failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.TemplateCreateTemplateTemporaryRequest](../../models/operations/templatecreatetemplatetemporaryrequest.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.TemplateCreateTemplateTemporaryResponse](../../models/operations/templatecreatetemplatetemporaryresponse.md)\>**
+
+### Errors
+
+| Error Type                                                | Status Code                                               | Content Type                                              |
+| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
+| errors.TemplateCreateTemplateTemporaryBadRequestError     | 400                                                       | application/json                                          |
+| errors.TemplateCreateTemplateTemporaryInternalServerError | 500                                                       | application/json                                          |
+| errors.APIError                                           | 4XX, 5XX                                                  | \*/\*                                                     |

package/docs/sdks/templates/README.md

@@ -18,6 +18,7 @@ Find templates based on a search criteria
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="template-findTemplates" method="get" path="/template" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -89,6 +90,7 @@ Get template
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="template-getTemplateById" method="get" path="/template/{templateId}" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -164,6 +166,7 @@ Update template
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="template-updateTemplate" method="post" path="/template/update" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -238,6 +241,7 @@ Duplicate template
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="template-duplicateTemplate" method="post" path="/template/duplicate" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -312,6 +316,7 @@ Delete template
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="template-deleteTemplate" method="post" path="/template/delete" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -386,6 +391,7 @@ Use the template to create a document
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="template-createDocumentFromTemplate" method="post" path="/template/use" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 

package/docs/sdks/templatesfields/README.md

@@ -18,6 +18,7 @@ Create a single field for a template.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="field-createTemplateField" method="post" path="/template/field/create" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -110,6 +111,7 @@ Returns a single field. If you want to retrieve all the fields for a template, u
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="field-getTemplateField" method="get" path="/template/field/{fieldId}" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -185,6 +187,7 @@ Create multiple fields for a template.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="field-createTemplateFields" method="post" path="/template/field/create-many" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -281,6 +284,7 @@ Update a single field for a template.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="field-updateTemplateField" method="post" path="/template/field/update" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -363,6 +367,7 @@ Update multiple fields for a template.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="field-updateTemplateFields" method="post" path="/template/field/update-many" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -449,6 +454,7 @@ Delete template field
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="field-deleteTemplateField" method="post" path="/template/field/delete" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 

package/docs/sdks/templatesrecipients/README.md

@@ -18,6 +18,7 @@ Returns a single recipient. If you want to retrieve all the recipients for a tem
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="recipient-getTemplateRecipient" method="get" path="/template/recipient/{recipientId}" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -93,6 +94,7 @@ Create a single recipient for a template.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="recipient-createTemplateRecipient" method="post" path="/template/recipient/create" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -177,6 +179,7 @@ Create multiple recipients for a template.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="recipient-createTemplateRecipients" method="post" path="/template/recipient/create-many" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -253,6 +256,7 @@ Update a single recipient for a template.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="recipient-updateTemplateRecipient" method="post" path="/template/recipient/update" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -333,6 +337,7 @@ Update multiple recipients for a template.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="recipient-updateTemplateRecipients" method="post" path="/template/recipient/update-many" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 
@@ -417,6 +422,7 @@ Delete template recipient
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="recipient-deleteTemplateRecipient" method="post" path="/template/recipient/delete" -->
 ```typescript
 import { Documenso } from "@documenso/sdk-typescript";
 

package/examples/README.md

@@ -0,0 +1,31 @@
+# @documenso/sdk-typescript Examples
+
+This directory contains example scripts demonstrating how to use the @documenso/sdk-typescript SDK.
+
+## Prerequisites
+
+- Node.js (v18 or higher)
+- npm
+
+## Setup
+
+1. Copy `.env.template` to `.env`:
+   ```bash
+   cp .env.template .env
+   ```
+
+2. Edit `.env` and add your actual credentials (API keys, tokens, etc.)
+
+## Running the Examples
+
+To run an example file from the examples directory:
+
+```bash
+npm run build && npx tsx example.ts
+```
+
+## Creating new examples
+
+Duplicate an existing example file, they won't be overwritten by the generation process.
+
+

package/examples/documentsGet.example.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import dotenv from "dotenv";
+dotenv.config();
+/**
+ * Example usage of the @documenso/sdk-typescript SDK
+ *
+ * To run this example from the examples directory:
+ * npm run build && npx tsx documentsGet.example.ts
+ */
+
+import { Documenso } from "@documenso/sdk-typescript";
+
+const documenso = new Documenso({
+  apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
+});
+
+async function main() {
+  const result = await documenso.documents.get({
+    documentId: 6150.61,
+  });
+
+  console.log(result);
+}
+
+main().catch(console.error);