npm - @documenso/sdk-typescript - Versions diffs - 0.3.0 → 0.3.1 - Mend

@documenso/sdk-typescript 0.3.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (217) hide show

package/docs/sdks/documents/README.md CHANGED Viewed

@@ -5,19 +5,18 @@
 ### Available Operations
+* [update](#update) - Update document
 * [find](#find) - Find documents
 * [get](#get) - Get document
 * [createV0](#createv0) - Create document
-* [update](#update) - Update document
 * [delete](#delete) - Delete document
-* [moveToTeam](#movetoteam) - Move document
 * [distribute](#distribute) - Distribute document
 * [redistribute](#redistribute) - Redistribute document
 * [duplicate](#duplicate) - Duplicate document
-## find
+## update
-Find documents based on a search criteria
+Update document
 ### Example Usage
@@ -29,7 +28,9 @@ const documenso = new Documenso({
 });
 async function run() {
-  const result = await documenso.documents.find({});
+  const result = await documenso.documents.update({
+    documentId: 9701.92,
+  });
   console.log(result);
 }
@@ -43,7 +44,7 @@ The standalone function version of this method:
 ```typescript
 import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
-import { documentsFind } from "@documenso/sdk-typescript/funcs/documentsFind.js";
+import { documentsUpdate } from "@documenso/sdk-typescript/funcs/documentsUpdate.js";
 // Use `DocumensoCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -52,12 +53,14 @@ const documenso = new DocumensoCore({
 });
 async function run() {
-  const res = await documentsFind(documenso, {});
+  const res = await documentsUpdate(documenso, {
+    documentId: 9701.92,
+  });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("documentsFind failed:", res.error);
+    console.log("documentsUpdate failed:", res.error);
   }
 }
@@ -68,27 +71,26 @@ run();
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.DocumentFindDocumentsRequest](../../models/operations/documentfinddocumentsrequest.md)                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.DocumentUpdateDocumentRequest](../../models/operations/documentupdatedocumentrequest.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.DocumentFindDocumentsResponse](../../models/operations/documentfinddocumentsresponse.md)\>**
+**Promise\<[operations.DocumentUpdateDocumentResponse](../../models/operations/documentupdatedocumentresponse.md)\>**
 ### Errors
-| Error Type                                      | Status Code                                     | Content Type                                    |
-| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
-| errors.DocumentFindDocumentsBadRequestError     | 400                                             | application/json                                |
-| errors.DocumentFindDocumentsNotFoundError       | 404                                             | application/json                                |
-| errors.DocumentFindDocumentsInternalServerError | 500                                             | application/json                                |
-| errors.APIError                                 | 4XX, 5XX                                        | \*/\*                                           |
+| Error Type                                       | Status Code                                      | Content Type                                     |
+| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
+| errors.DocumentUpdateDocumentBadRequestError     | 400                                              | application/json                                 |
+| errors.DocumentUpdateDocumentInternalServerError | 500                                              | application/json                                 |
+| errors.APIError                                  | 4XX, 5XX                                         | \*/\*                                            |
-## get
+## find
-Returns a document given an ID
+Find documents based on a search criteria
 ### Example Usage
@@ -100,9 +102,7 @@ const documenso = new Documenso({
 });
 async function run() {
-  const result = await documenso.documents.get({
-    documentId: 7491.86,
-  });
+  const result = await documenso.documents.find({});
   console.log(result);
 }
@@ -116,7 +116,7 @@ The standalone function version of this method:
 ```typescript
 import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
-import { documentsGet } from "@documenso/sdk-typescript/funcs/documentsGet.js";
+import { documentsFind } from "@documenso/sdk-typescript/funcs/documentsFind.js";
 // Use `DocumensoCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -125,14 +125,12 @@ const documenso = new DocumensoCore({
 });
 async function run() {
-  const res = await documentsGet(documenso, {
-    documentId: 7491.86,
-  });
+  const res = await documentsFind(documenso, {});
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("documentsGet failed:", res.error);
+    console.log("documentsFind failed:", res.error);
   }
 }
@@ -143,27 +141,27 @@ run();
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.DocumentGetDocumentWithDetailsByIdRequest](../../models/operations/documentgetdocumentwithdetailsbyidrequest.md)                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.DocumentFindDocumentsRequest](../../models/operations/documentfinddocumentsrequest.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.DocumentGetDocumentWithDetailsByIdResponse](../../models/operations/documentgetdocumentwithdetailsbyidresponse.md)\>**
+**Promise\<[operations.DocumentFindDocumentsResponse](../../models/operations/documentfinddocumentsresponse.md)\>**
 ### Errors
-| Error Type                                                   | Status Code                                                  | Content Type                                                 |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| errors.DocumentGetDocumentWithDetailsByIdBadRequestError     | 400                                                          | application/json                                             |
-| errors.DocumentGetDocumentWithDetailsByIdNotFoundError       | 404                                                          | application/json                                             |
-| errors.DocumentGetDocumentWithDetailsByIdInternalServerError | 500                                                          | application/json                                             |
-| errors.APIError                                              | 4XX, 5XX                                                     | \*/\*                                                        |
+| Error Type                                      | Status Code                                     | Content Type                                    |
+| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
+| errors.DocumentFindDocumentsBadRequestError     | 400                                             | application/json                                |
+| errors.DocumentFindDocumentsNotFoundError       | 404                                             | application/json                                |
+| errors.DocumentFindDocumentsInternalServerError | 500                                             | application/json                                |
+| errors.APIError                                 | 4XX, 5XX                                        | \*/\*                                           |
-## createV0
+## get
-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.
+Returns a document given an ID
 ### Example Usage
@@ -175,8 +173,8 @@ const documenso = new Documenso({
 });
 async function run() {
-  const result = await documenso.documents.createV0({
-    title: "<value>",
+  const result = await documenso.documents.get({
+    documentId: 7491.86,
   });
   console.log(result);
@@ -191,7 +189,7 @@ The standalone function version of this method:
 ```typescript
 import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
-import { documentsCreateV0 } from "@documenso/sdk-typescript/funcs/documentsCreateV0.js";
+import { documentsGet } from "@documenso/sdk-typescript/funcs/documentsGet.js";
 // Use `DocumensoCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -200,14 +198,14 @@ const documenso = new DocumensoCore({
 });
 async function run() {
-  const res = await documentsCreateV0(documenso, {
-    title: "<value>",
+  const res = await documentsGet(documenso, {
+    documentId: 7491.86,
   });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("documentsCreateV0 failed:", res.error);
+    console.log("documentsGet failed:", res.error);
   }
 }
@@ -218,26 +216,27 @@ run();
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.DocumentCreateDocumentTemporaryRequest](../../models/operations/documentcreatedocumenttemporaryrequest.md)                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.DocumentGetDocumentWithDetailsByIdRequest](../../models/operations/documentgetdocumentwithdetailsbyidrequest.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.DocumentCreateDocumentTemporaryResponse](../../models/operations/documentcreatedocumenttemporaryresponse.md)\>**
+**Promise\<[operations.DocumentGetDocumentWithDetailsByIdResponse](../../models/operations/documentgetdocumentwithdetailsbyidresponse.md)\>**
 ### Errors
-| Error Type                                                | Status Code                                               | Content Type                                              |
-| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
-| errors.DocumentCreateDocumentTemporaryBadRequestError     | 400                                                       | application/json                                          |
-| errors.DocumentCreateDocumentTemporaryInternalServerError | 500                                                       | application/json                                          |
-| errors.APIError                                           | 4XX, 5XX                                                  | \*/\*                                                     |
+| Error Type                                                   | Status Code                                                  | Content Type                                                 |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| errors.DocumentGetDocumentWithDetailsByIdBadRequestError     | 400                                                          | application/json                                             |
+| errors.DocumentGetDocumentWithDetailsByIdNotFoundError       | 404                                                          | application/json                                             |
+| errors.DocumentGetDocumentWithDetailsByIdInternalServerError | 500                                                          | application/json                                             |
+| errors.APIError                                              | 4XX, 5XX                                                     | \*/\*                                                        |
-## update
+## createV0
-Update document
+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
@@ -249,8 +248,8 @@ const documenso = new Documenso({
 });
 async function run() {
-  const result = await documenso.documents.update({
-    documentId: 9701.92,
+  const result = await documenso.documents.createV0({
+    title: "<value>",
   });
   console.log(result);
@@ -265,7 +264,7 @@ The standalone function version of this method:
 ```typescript
 import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
-import { documentsUpdate } from "@documenso/sdk-typescript/funcs/documentsUpdate.js";
+import { documentsCreateV0 } from "@documenso/sdk-typescript/funcs/documentsCreateV0.js";
 // Use `DocumensoCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -274,14 +273,14 @@ const documenso = new DocumensoCore({
 });
 async function run() {
-  const res = await documentsUpdate(documenso, {
-    documentId: 9701.92,
+  const res = await documentsCreateV0(documenso, {
+    title: "<value>",
   });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("documentsUpdate failed:", res.error);
+    console.log("documentsCreateV0 failed:", res.error);
   }
 }
@@ -292,22 +291,22 @@ run();
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.DocumentUpdateDocumentRequest](../../models/operations/documentupdatedocumentrequest.md)                                                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.DocumentCreateDocumentTemporaryRequest](../../models/operations/documentcreatedocumenttemporaryrequest.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.DocumentUpdateDocumentResponse](../../models/operations/documentupdatedocumentresponse.md)\>**
+**Promise\<[operations.DocumentCreateDocumentTemporaryResponse](../../models/operations/documentcreatedocumenttemporaryresponse.md)\>**
 ### Errors
-| Error Type                                       | Status Code                                      | Content Type                                     |
-| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
-| errors.DocumentUpdateDocumentBadRequestError     | 400                                              | application/json                                 |
-| errors.DocumentUpdateDocumentInternalServerError | 500                                              | application/json                                 |
-| errors.APIError                                  | 4XX, 5XX                                         | \*/\*                                            |
+| Error Type                                                | Status Code                                               | Content Type                                              |
+| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
+| errors.DocumentCreateDocumentTemporaryBadRequestError     | 400                                                       | application/json                                          |
+| errors.DocumentCreateDocumentTemporaryInternalServerError | 500                                                       | application/json                                          |
+| errors.APIError                                           | 4XX, 5XX                                                  | \*/\*                                                     |
 ## delete
@@ -383,82 +382,6 @@ run();
 | errors.DocumentDeleteDocumentInternalServerError | 500                                              | application/json                                 |
 | errors.APIError                                  | 4XX, 5XX                                         | \*/\*                                            |
-## moveToTeam
-Move a document from your personal account to a team
-### 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.documents.moveToTeam({
-    documentId: 7184.15,
-    teamId: 4855.19,
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
-import { documentsMoveToTeam } from "@documenso/sdk-typescript/funcs/documentsMoveToTeam.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 documentsMoveToTeam(documenso, {
-    documentId: 7184.15,
-    teamId: 4855.19,
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("documentsMoveToTeam failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.DocumentMoveDocumentToTeamRequest](../../models/operations/documentmovedocumenttoteamrequest.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.DocumentMoveDocumentToTeamResponse](../../models/operations/documentmovedocumenttoteamresponse.md)\>**
-### Errors
-| Error Type                                           | Status Code                                          | Content Type                                         |
-| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
-| errors.DocumentMoveDocumentToTeamBadRequestError     | 400                                                  | application/json                                     |
-| errors.DocumentMoveDocumentToTeamInternalServerError | 500                                                  | application/json                                     |
-| errors.APIError                                      | 4XX, 5XX                                             | \*/\*                                                |
 ## distribute
 Send the document out to recipients based on your distribution method

package/docs/sdks/templates/README.md CHANGED Viewed

@@ -11,7 +11,6 @@
 * [duplicate](#duplicate) - Duplicate template
 * [delete](#delete) - Delete template
 * [use](#use) - Use template
-* [moveToTeam](#movetoteam) - Move template
 ## find
@@ -455,80 +454,4 @@ run();
 | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
 | errors.TemplateCreateDocumentFromTemplateBadRequestError     | 400                                                          | application/json                                             |
 | errors.TemplateCreateDocumentFromTemplateInternalServerError | 500                                                          | application/json                                             |
-| errors.APIError                                              | 4XX, 5XX                                                     | \*/\*                                                        |
-## moveToTeam
-Move a template to a team
-### 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.templates.moveToTeam({
-    templateId: 9124,
-    teamId: 6200.73,
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
-import { templatesMoveToTeam } from "@documenso/sdk-typescript/funcs/templatesMoveToTeam.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 templatesMoveToTeam(documenso, {
-    templateId: 9124,
-    teamId: 6200.73,
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("templatesMoveToTeam failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.TemplateMoveTemplateToTeamRequest](../../models/operations/templatemovetemplatetoteamrequest.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.TemplateMoveTemplateToTeamResponse](../../models/operations/templatemovetemplatetoteamresponse.md)\>**
-### Errors
-| Error Type                                           | Status Code                                          | Content Type                                         |
-| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
-| errors.TemplateMoveTemplateToTeamBadRequestError     | 400                                                  | application/json                                     |
-| errors.TemplateMoveTemplateToTeamInternalServerError | 500                                                  | application/json                                     |
-| errors.APIError                                      | 4XX, 5XX                                             | \*/\*                                                |
+| errors.APIError                                              | 4XX, 5XX                                                     | \*/\*                                                        |

package/jsr.json CHANGED Viewed

@@ -2,7 +2,7 @@
 {
   "name": "@documenso/sdk-typescript",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "exports": {
     ".": "./src/index.ts",
     "./models/errors": "./src/models/errors/index.ts",

package/lib/config.d.ts CHANGED Viewed

@@ -31,8 +31,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
 export declare const SDK_METADATA: {
     readonly language: "typescript";
     readonly openapiDocVersion: "0.0.0";
-    readonly sdkVersion: "0.3.0";
-    readonly genVersion: "2.623.0";
-    readonly userAgent: "speakeasy-sdk/typescript 0.3.0 2.623.0 0.0.0 @documenso/sdk-typescript";
+    readonly sdkVersion: "0.3.1";
+    readonly genVersion: "2.644.1";
+    readonly userAgent: "speakeasy-sdk/typescript 0.3.1 2.644.1 0.0.0 @documenso/sdk-typescript";
 };
 //# sourceMappingURL=config.d.ts.map

package/lib/config.js CHANGED Viewed

@@ -28,8 +28,8 @@ function serverURLFromOptions(options) {
 exports.SDK_METADATA = {
     language: "typescript",
     openapiDocVersion: "0.0.0",
-    sdkVersion: "0.3.0",
-    genVersion: "2.623.0",
-    userAgent: "speakeasy-sdk/typescript 0.3.0 2.623.0 0.0.0 @documenso/sdk-typescript",
+    sdkVersion: "0.3.1",
+    genVersion: "2.644.1",
+    userAgent: "speakeasy-sdk/typescript 0.3.1 2.644.1 0.0.0 @documenso/sdk-typescript",
 };
 //# sourceMappingURL=config.js.map

package/lib/files.d.ts CHANGED Viewed

@@ -5,4 +5,9 @@
  * request structure.
  */
 export declare function readableStreamToArrayBuffer(readable: ReadableStream<Uint8Array>): Promise<ArrayBuffer>;
+/**
+ * Determines the MIME content type based on a file's extension.
+ * Returns null if the extension is not recognized.
+ */
+export declare function getContentTypeFromFileName(fileName: string): string | null;
 //# sourceMappingURL=files.d.ts.map

package/lib/files.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../src/lib/files.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,wBAAsB,2BAA2B,CAC/C,QAAQ,EAAE,cAAc,CAAC,UAAU,CAAC,GACnC,OAAO,CAAC,WAAW,CAAC,CA2BtB"}
1	+ {"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../src/lib/files.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,wBAAsB,2BAA2B,CAC/C,QAAQ,EAAE,cAAc,CAAC,UAAU,CAAC,GACnC,OAAO,CAAC,WAAW,CAAC,CA2BtB;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAoC1E"}

package/lib/files.js CHANGED Viewed

@@ -4,6 +4,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.readableStreamToArrayBuffer = readableStreamToArrayBuffer;
+exports.getContentTypeFromFileName = getContentTypeFromFileName;
 /**
  * Consumes a stream and returns a concatenated array buffer. Useful in
  * situations where we need to read the whole file because it forms part of a
@@ -33,4 +34,44 @@ async function readableStreamToArrayBuffer(readable) {
     }
     return concatenatedChunks.buffer;
 }
+/**
+ * Determines the MIME content type based on a file's extension.
+ * Returns null if the extension is not recognized.
+ */
+function getContentTypeFromFileName(fileName) {
+    if (!fileName)
+        return null;
+    const ext = fileName.toLowerCase().split(".").pop();
+    if (!ext)
+        return null;
+    const mimeTypes = {
+        json: "application/json",
+        xml: "application/xml",
+        html: "text/html",
+        htm: "text/html",
+        txt: "text/plain",
+        csv: "text/csv",
+        pdf: "application/pdf",
+        png: "image/png",
+        jpg: "image/jpeg",
+        jpeg: "image/jpeg",
+        gif: "image/gif",
+        svg: "image/svg+xml",
+        js: "application/javascript",
+        css: "text/css",
+        zip: "application/zip",
+        tar: "application/x-tar",
+        gz: "application/gzip",
+        mp4: "video/mp4",
+        mp3: "audio/mpeg",
+        wav: "audio/wav",
+        webp: "image/webp",
+        ico: "image/x-icon",
+        woff: "font/woff",
+        woff2: "font/woff2",
+        ttf: "font/ttf",
+        otf: "font/otf",
+    };
+    return mimeTypes[ext] || null;
+}
 //# sourceMappingURL=files.js.map