@documenso/sdk-typescript 0.1.1 → 0.1.3

package/docs/sdks/recipients/README.md

@@ -1,15 +1,20 @@
 # Recipients
-(*recipients*)
+(*documents.recipients*)
 
 ## Overview
 
 ### Available Operations
 
-* [get](#get) - Get recipient
+* [get](#get) - Get document recipient
+* [create](#create) - Create document recipient
+* [createMany](#createmany) - Create document recipients
+* [update](#update) - Update document recipient
+* [updateMany](#updatemany) - Update document recipients
+* [delete](#delete) - Delete document recipient
 
 ## get
 
-Returns a single recipient. If you want to retrieve all the recipients for a document or template, use the "Get Document" or "Get Template" request.
+Returns a single recipient. If you want to retrieve all the recipients for a document, use the "Get Document" endpoint.
 
 ### Example Usage
 
@@ -21,8 +26,8 @@ const documenso = new Documenso({
 });
 
 async function run() {
-  const result = await documenso.recipients.get({
-    recipientId: 6011.36,
+  const result = await documenso.documents.recipients.get({
+    recipientId: 237.59,
   });
 
   // Handle the result
@@ -38,7 +43,7 @@ The standalone function version of this method:
 
 ```typescript
 import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
-import { recipientsGet } from "@documenso/sdk-typescript/funcs/recipientsGet.js";
+import { documentsRecipientsGet } from "@documenso/sdk-typescript/funcs/documentsRecipientsGet.js";
 
 // Use `DocumensoCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -47,8 +52,8 @@ const documenso = new DocumensoCore({
 });
 
 async function run() {
-  const res = await recipientsGet(documenso, {
-    recipientId: 6011.36,
+  const res = await documentsRecipientsGet(documenso, {
+    recipientId: 237.59,
   });
 
   if (!res.ok) {
@@ -68,20 +73,466 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.RecipientGetRecipientRequest](../../models/operations/recipientgetrecipientrequest.md)                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.RecipientGetDocumentRecipientRequest](../../models/operations/recipientgetdocumentrecipientrequest.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.RecipientGetRecipientResponseBody](../../models/operations/recipientgetrecipientresponsebody.md)\>**
+**Promise\<[operations.RecipientGetDocumentRecipientResponseBody](../../models/operations/recipientgetdocumentrecipientresponsebody.md)\>**
 
 ### Errors
 
-| Error Type                      | Status Code                     | Content Type                    |
-| ------------------------------- | ------------------------------- | ------------------------------- |
-| errors.ErrorBADREQUEST          | 400                             | application/json                |
-| errors.ErrorNOTFOUND            | 404                             | application/json                |
-| errors.Errorinternalservererror | 500                             | application/json                |
-| errors.APIError                 | 4XX, 5XX                        | \*/\*                           |
+| Error Type                                                                  | Status Code                                                                 | Content Type                                                                |
+| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| errors.RecipientGetDocumentRecipientResponseBody                            | 400                                                                         | application/json                                                            |
+| errors.RecipientGetDocumentRecipientDocumentsRecipientsResponseBody         | 404                                                                         | application/json                                                            |
+| errors.RecipientGetDocumentRecipientDocumentsRecipientsResponseResponseBody | 500                                                                         | application/json                                                            |
+| errors.APIError                                                             | 4XX, 5XX                                                                    | \*/\*                                                                       |
+
+## create
+
+Create a single recipient for a document.
+
+### 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.recipients.create({
+    documentId: 4865.89,
+    recipient: {
+      email: "Haylie_Bernhard95@yahoo.com",
+      name: "<value>",
+      role: "CC",
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
+import { documentsRecipientsCreate } from "@documenso/sdk-typescript/funcs/documentsRecipientsCreate.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 documentsRecipientsCreate(documenso, {
+    documentId: 4865.89,
+    recipient: {
+      email: "Haylie_Bernhard95@yahoo.com",
+      name: "<value>",
+      role: "CC",
+    },
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.RecipientCreateDocumentRecipientRequestBody](../../models/operations/recipientcreatedocumentrecipientrequestbody.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.RecipientCreateDocumentRecipientResponseBody](../../models/operations/recipientcreatedocumentrecipientresponsebody.md)\>**
+
+### Errors
+
+| Error Type                                                             | Status Code                                                            | Content Type                                                           |
+| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
+| errors.RecipientCreateDocumentRecipientResponseBody                    | 400                                                                    | application/json                                                       |
+| errors.RecipientCreateDocumentRecipientDocumentsRecipientsResponseBody | 500                                                                    | application/json                                                       |
+| errors.APIError                                                        | 4XX, 5XX                                                               | \*/\*                                                                  |
+
+## createMany
+
+Create multiple recipients for a document.
+
+### 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.recipients.createMany({
+    documentId: 5158.41,
+    recipients: [
+      {
+        email: "Demetrius.Sanford35@hotmail.com",
+        name: "<value>",
+        role: "VIEWER",
+      },
+      {
+        email: "Lyla50@yahoo.com",
+        name: "<value>",
+        role: "APPROVER",
+      },
+    ],
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
+import { documentsRecipientsCreateMany } from "@documenso/sdk-typescript/funcs/documentsRecipientsCreateMany.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 documentsRecipientsCreateMany(documenso, {
+    documentId: 5158.41,
+    recipients: [
+      {
+        email: "Demetrius.Sanford35@hotmail.com",
+        name: "<value>",
+        role: "VIEWER",
+      },
+      {
+        email: "Lyla50@yahoo.com",
+        name: "<value>",
+        role: "APPROVER",
+      },
+    ],
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.RecipientCreateDocumentRecipientsRequestBody](../../models/operations/recipientcreatedocumentrecipientsrequestbody.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.RecipientCreateDocumentRecipientsResponseBody](../../models/operations/recipientcreatedocumentrecipientsresponsebody.md)\>**
+
+### Errors
+
+| Error Type                                                              | Status Code                                                             | Content Type                                                            |
+| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
+| errors.RecipientCreateDocumentRecipientsResponseBody                    | 400                                                                     | application/json                                                        |
+| errors.RecipientCreateDocumentRecipientsDocumentsRecipientsResponseBody | 500                                                                     | application/json                                                        |
+| errors.APIError                                                         | 4XX, 5XX                                                                | \*/\*                                                                   |
+
+## update
+
+Update a single recipient for a document.
+
+### 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.recipients.update({
+    documentId: 8574.78,
+    recipient: {
+      id: 5971.29,
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
+import { documentsRecipientsUpdate } from "@documenso/sdk-typescript/funcs/documentsRecipientsUpdate.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 documentsRecipientsUpdate(documenso, {
+    documentId: 8574.78,
+    recipient: {
+      id: 5971.29,
+    },
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.RecipientUpdateDocumentRecipientRequestBody](../../models/operations/recipientupdatedocumentrecipientrequestbody.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.RecipientUpdateDocumentRecipientResponseBody](../../models/operations/recipientupdatedocumentrecipientresponsebody.md)\>**
+
+### Errors
+
+| Error Type                                                             | Status Code                                                            | Content Type                                                           |
+| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
+| errors.RecipientUpdateDocumentRecipientResponseBody                    | 400                                                                    | application/json                                                       |
+| errors.RecipientUpdateDocumentRecipientDocumentsRecipientsResponseBody | 500                                                                    | application/json                                                       |
+| errors.APIError                                                        | 4XX, 5XX                                                               | \*/\*                                                                  |
+
+## updateMany
+
+Update multiple recipients for a document.
+
+### 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.recipients.updateMany({
+    documentId: 4057.69,
+    recipients: [
+      {
+        id: 5359.16,
+      },
+      {
+        id: 8982.15,
+      },
+    ],
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
+import { documentsRecipientsUpdateMany } from "@documenso/sdk-typescript/funcs/documentsRecipientsUpdateMany.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 documentsRecipientsUpdateMany(documenso, {
+    documentId: 4057.69,
+    recipients: [
+      {
+        id: 5359.16,
+      },
+      {
+        id: 8982.15,
+      },
+    ],
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.RecipientUpdateDocumentRecipientsRequestBody](../../models/operations/recipientupdatedocumentrecipientsrequestbody.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.RecipientUpdateDocumentRecipientsResponseBody](../../models/operations/recipientupdatedocumentrecipientsresponsebody.md)\>**
+
+### Errors
+
+| Error Type                                                              | Status Code                                                             | Content Type                                                            |
+| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
+| errors.RecipientUpdateDocumentRecipientsResponseBody                    | 400                                                                     | application/json                                                        |
+| errors.RecipientUpdateDocumentRecipientsDocumentsRecipientsResponseBody | 500                                                                     | application/json                                                        |
+| errors.APIError                                                         | 4XX, 5XX                                                                | \*/\*                                                                   |
+
+## delete
+
+Delete document recipient
+
+### 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.recipients.delete({
+    recipientId: 5459.07,
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
+import { documentsRecipientsDelete } from "@documenso/sdk-typescript/funcs/documentsRecipientsDelete.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 documentsRecipientsDelete(documenso, {
+    recipientId: 5459.07,
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.RecipientDeleteDocumentRecipientRequestBody](../../models/operations/recipientdeletedocumentrecipientrequestbody.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.RecipientDeleteDocumentRecipientResponseBody](../../models/operations/recipientdeletedocumentrecipientresponsebody.md)\>**
+
+### Errors
+
+| Error Type                                                             | Status Code                                                            | Content Type                                                           |
+| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
+| errors.RecipientDeleteDocumentRecipientResponseBody                    | 400                                                                    | application/json                                                       |
+| errors.RecipientDeleteDocumentRecipientDocumentsRecipientsResponseBody | 500                                                                    | application/json                                                       |
+| errors.APIError                                                        | 4XX, 5XX                                                               | \*/\*                                                                  |