@documenso/sdk-typescript 0.1.1 → 0.1.2
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.
- package/FUNCTIONS.md +3 -1
- package/README.md +76 -69
- package/docs/sdks/directlink/README.md +7 -7
- package/docs/sdks/documensofields/README.md +184 -96
- package/docs/sdks/documensorecipients/README.md +162 -54
- package/docs/sdks/documents/README.md +26 -22
- package/docs/sdks/fields/README.md +491 -10
- package/docs/sdks/recipients/README.md +461 -10
- package/docs/sdks/templates/README.md +31 -17
- package/funcs/documentsDelete.d.ts +1 -1
- package/funcs/documentsDelete.d.ts.map +1 -1
- package/funcs/documentsDelete.js +1 -2
- package/funcs/documentsDelete.js.map +1 -1
- package/funcs/documentsFieldsDelete.d.ts +1 -1
- package/funcs/documentsFieldsDelete.d.ts.map +1 -1
- package/funcs/documentsFieldsDelete.js +1 -2
- package/funcs/documentsFieldsDelete.js.map +1 -1
- package/funcs/{fieldsGet.d.ts → documentsFieldsGet.d.ts} +4 -4
- package/funcs/documentsFieldsGet.d.ts.map +1 -0
- package/funcs/{recipientsGet.js → documentsFieldsGet.js} +10 -10
- package/funcs/documentsFieldsGet.js.map +1 -0
- package/funcs/documentsRecipientsDelete.d.ts +1 -1
- package/funcs/documentsRecipientsDelete.d.ts.map +1 -1
- package/funcs/documentsRecipientsDelete.js +1 -2
- package/funcs/documentsRecipientsDelete.js.map +1 -1
- package/funcs/{recipientsGet.d.ts → documentsRecipientsGet.d.ts} +4 -4
- package/funcs/documentsRecipientsGet.d.ts.map +1 -0
- package/funcs/documentsRecipientsGet.js +116 -0
- package/funcs/documentsRecipientsGet.js.map +1 -0
- package/funcs/documentsRedistribute.d.ts +1 -1
- package/funcs/documentsRedistribute.d.ts.map +1 -1
- package/funcs/documentsRedistribute.js +1 -2
- package/funcs/documentsRedistribute.js.map +1 -1
- package/funcs/templatesDelete.d.ts +1 -1
- package/funcs/templatesDelete.d.ts.map +1 -1
- package/funcs/templatesDelete.js +1 -2
- package/funcs/templatesDelete.js.map +1 -1
- package/funcs/templatesDirectLinkDelete.d.ts +1 -1
- package/funcs/templatesDirectLinkDelete.d.ts.map +1 -1
- package/funcs/templatesDirectLinkDelete.js +1 -2
- package/funcs/templatesDirectLinkDelete.js.map +1 -1
- package/funcs/templatesFieldsDelete.d.ts +1 -1
- package/funcs/templatesFieldsDelete.d.ts.map +1 -1
- package/funcs/templatesFieldsDelete.js +1 -2
- package/funcs/templatesFieldsDelete.js.map +1 -1
- package/funcs/templatesFieldsGet.d.ts +16 -0
- package/funcs/templatesFieldsGet.d.ts.map +1 -0
- package/funcs/{fieldsGet.js → templatesFieldsGet.js} +9 -9
- package/funcs/templatesFieldsGet.js.map +1 -0
- package/funcs/templatesRecipientsDelete.d.ts +1 -1
- package/funcs/templatesRecipientsDelete.d.ts.map +1 -1
- package/funcs/templatesRecipientsDelete.js +1 -2
- package/funcs/templatesRecipientsDelete.js.map +1 -1
- package/funcs/templatesRecipientsGet.d.ts +16 -0
- package/funcs/templatesRecipientsGet.d.ts.map +1 -0
- package/funcs/templatesRecipientsGet.js +116 -0
- package/funcs/templatesRecipientsGet.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +4 -4
- package/lib/config.d.ts.map +1 -1
- package/lib/config.js +4 -4
- package/lib/config.js.map +1 -1
- package/lib/schemas.d.ts +1 -1
- package/lib/schemas.d.ts.map +1 -1
- package/lib/schemas.js +4 -1
- package/lib/schemas.js.map +1 -1
- package/models/operations/documentdeletedocument.d.ts +28 -0
- package/models/operations/documentdeletedocument.d.ts.map +1 -1
- package/models/operations/documentdeletedocument.js +28 -1
- package/models/operations/documentdeletedocument.js.map +1 -1
- package/models/operations/documentresenddocument.d.ts +28 -0
- package/models/operations/documentresenddocument.d.ts.map +1 -1
- package/models/operations/documentresenddocument.js +28 -1
- package/models/operations/documentresenddocument.js.map +1 -1
- package/models/operations/fielddeletedocumentfield.d.ts +28 -0
- package/models/operations/fielddeletedocumentfield.d.ts.map +1 -1
- package/models/operations/fielddeletedocumentfield.js +28 -1
- package/models/operations/fielddeletedocumentfield.js.map +1 -1
- package/models/operations/fielddeletetemplatefield.d.ts +28 -0
- package/models/operations/fielddeletetemplatefield.d.ts.map +1 -1
- package/models/operations/fielddeletetemplatefield.js +28 -1
- package/models/operations/fielddeletetemplatefield.js.map +1 -1
- package/models/operations/{fieldgetfield.d.ts → fieldgetdocumentfield.d.ts} +142 -142
- package/models/operations/fieldgetdocumentfield.d.ts.map +1 -0
- package/models/operations/fieldgetdocumentfield.js +817 -0
- package/models/operations/fieldgetdocumentfield.js.map +1 -0
- package/models/operations/fieldgettemplatefield.d.ts +774 -0
- package/models/operations/fieldgettemplatefield.d.ts.map +1 -0
- package/models/operations/fieldgettemplatefield.js +819 -0
- package/models/operations/fieldgettemplatefield.js.map +1 -0
- package/models/operations/index.d.ts +4 -2
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +4 -2
- package/models/operations/index.js.map +1 -1
- package/models/operations/recipientdeletedocumentrecipient.d.ts +28 -0
- package/models/operations/recipientdeletedocumentrecipient.d.ts.map +1 -1
- package/models/operations/recipientdeletedocumentrecipient.js +28 -1
- package/models/operations/recipientdeletedocumentrecipient.js.map +1 -1
- package/models/operations/recipientdeletetemplaterecipient.d.ts +28 -0
- package/models/operations/recipientdeletetemplaterecipient.d.ts.map +1 -1
- package/models/operations/recipientdeletetemplaterecipient.js +28 -1
- package/models/operations/recipientdeletetemplaterecipient.js.map +1 -1
- package/models/operations/recipientgetdocumentrecipient.d.ts +1041 -0
- package/models/operations/recipientgetdocumentrecipient.d.ts.map +1 -0
- package/models/operations/recipientgetdocumentrecipient.js +1038 -0
- package/models/operations/recipientgetdocumentrecipient.js.map +1 -0
- package/models/operations/recipientgettemplaterecipient.d.ts +1041 -0
- package/models/operations/recipientgettemplaterecipient.d.ts.map +1 -0
- package/models/operations/recipientgettemplaterecipient.js +1039 -0
- package/models/operations/recipientgettemplaterecipient.js.map +1 -0
- package/models/operations/templatedeletetemplate.d.ts +28 -0
- package/models/operations/templatedeletetemplate.d.ts.map +1 -1
- package/models/operations/templatedeletetemplate.js +28 -1
- package/models/operations/templatedeletetemplate.js.map +1 -1
- package/models/operations/templatedeletetemplatedirectlink.d.ts +28 -0
- package/models/operations/templatedeletetemplatedirectlink.d.ts.map +1 -1
- package/models/operations/templatedeletetemplatedirectlink.js +28 -1
- package/models/operations/templatedeletetemplatedirectlink.js.map +1 -1
- package/package.json +5 -1
- package/sdk/directlink.d.ts +1 -1
- package/sdk/directlink.d.ts.map +1 -1
- package/sdk/documensofields.d.ts +21 -14
- package/sdk/documensofields.d.ts.map +1 -1
- package/sdk/documensofields.js +29 -19
- package/sdk/documensofields.js.map +1 -1
- package/sdk/documensorecipients.d.ts +21 -14
- package/sdk/documensorecipients.d.ts.map +1 -1
- package/sdk/documensorecipients.js +29 -19
- package/sdk/documensorecipients.js.map +1 -1
- package/sdk/documents.d.ts +6 -6
- package/sdk/documents.d.ts.map +1 -1
- package/sdk/documents.js +4 -4
- package/sdk/documents.js.map +1 -1
- package/sdk/fields.d.ts +35 -3
- package/sdk/fields.d.ts.map +1 -1
- package/sdk/fields.js +51 -4
- package/sdk/fields.js.map +1 -1
- package/sdk/recipients.d.ts +35 -3
- package/sdk/recipients.d.ts.map +1 -1
- package/sdk/recipients.js +51 -4
- package/sdk/recipients.js.map +1 -1
- package/sdk/sdk.d.ts +0 -6
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +0 -8
- package/sdk/sdk.js.map +1 -1
- package/sdk/templates.d.ts +5 -5
- package/sdk/templates.d.ts.map +1 -1
- package/sdk/templates.js +4 -4
- package/sdk/templates.js.map +1 -1
- package/src/funcs/documentsDelete.ts +3 -4
- package/src/funcs/documentsFieldsDelete.ts +3 -4
- package/src/funcs/{fieldsGet.ts → documentsFieldsGet.ts} +11 -10
- package/src/funcs/documentsRecipientsDelete.ts +6 -4
- package/src/funcs/{recipientsGet.ts → documentsRecipientsGet.ts} +15 -10
- package/src/funcs/documentsRedistribute.ts +3 -4
- package/src/funcs/templatesDelete.ts +3 -4
- package/src/funcs/templatesDirectLinkDelete.ts +6 -4
- package/src/funcs/templatesFieldsDelete.ts +3 -4
- package/src/funcs/templatesFieldsGet.ts +147 -0
- package/src/funcs/templatesRecipientsDelete.ts +6 -4
- package/src/funcs/templatesRecipientsGet.ts +152 -0
- package/src/lib/config.ts +4 -4
- package/src/lib/schemas.ts +5 -0
- package/src/models/operations/documentdeletedocument.ts +65 -0
- package/src/models/operations/documentresenddocument.ts +65 -0
- package/src/models/operations/fielddeletedocumentfield.ts +66 -0
- package/src/models/operations/fielddeletetemplatefield.ts +66 -0
- package/src/models/operations/{fieldgetfield.ts → fieldgetdocumentfield.ts} +337 -282
- package/src/models/operations/fieldgettemplatefield.ts +1697 -0
- package/src/models/operations/index.ts +4 -2
- package/src/models/operations/recipientdeletedocumentrecipient.ts +74 -0
- package/src/models/operations/recipientdeletetemplaterecipient.ts +74 -0
- package/src/models/operations/recipientgetdocumentrecipient.ts +2235 -0
- package/src/models/operations/recipientgettemplaterecipient.ts +2251 -0
- package/src/models/operations/templatedeletetemplate.ts +65 -0
- package/src/models/operations/templatedeletetemplatedirectlink.ts +74 -0
- package/src/sdk/directlink.ts +1 -1
- package/src/sdk/documensofields.ts +47 -29
- package/src/sdk/documensorecipients.ts +47 -29
- package/src/sdk/documents.ts +10 -10
- package/src/sdk/fields.ts +93 -6
- package/src/sdk/recipients.ts +93 -6
- package/src/sdk/sdk.ts +0 -12
- package/src/sdk/templates.ts +9 -11
- package/.devcontainer/README.md +0 -30
- package/.devcontainer/devcontainer.json +0 -45
- package/docs/sdks/documensotemplatesfields/README.md +0 -456
- package/docs/sdks/documensotemplatesrecipients/README.md +0 -440
- package/funcs/fieldsGet.d.ts.map +0 -1
- package/funcs/fieldsGet.js.map +0 -1
- package/funcs/recipientsGet.d.ts.map +0 -1
- package/funcs/recipientsGet.js.map +0 -1
- package/local-openapi.json +0 -21024
- package/models/operations/fieldgetfield.d.ts.map +0 -1
- package/models/operations/fieldgetfield.js +0 -820
- package/models/operations/fieldgetfield.js.map +0 -1
- package/models/operations/recipientgetrecipient.d.ts +0 -1041
- package/models/operations/recipientgetrecipient.d.ts.map +0 -1
- package/models/operations/recipientgetrecipient.js +0 -1033
- package/models/operations/recipientgetrecipient.js.map +0 -1
- package/sdk/documensotemplatesfields.d.ts +0 -37
- package/sdk/documensotemplatesfields.d.ts.map +0 -1
- package/sdk/documensotemplatesfields.js +0 -59
- package/sdk/documensotemplatesfields.js.map +0 -1
- package/sdk/documensotemplatesrecipients.d.ts +0 -37
- package/sdk/documensotemplatesrecipients.d.ts.map +0 -1
- package/sdk/documensotemplatesrecipients.js +0 -59
- package/sdk/documensotemplatesrecipients.js.map +0 -1
- package/src/models/operations/recipientgetrecipient.ts +0 -2060
- package/src/sdk/documensotemplatesfields.ts +0 -96
- package/src/sdk/documensotemplatesrecipients.ts +0 -96
|
@@ -1,19 +1,99 @@
|
|
|
1
1
|
# DocumensoRecipients
|
|
2
|
-
(*
|
|
2
|
+
(*templates.recipients*)
|
|
3
3
|
|
|
4
4
|
## Overview
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
-
* [
|
|
9
|
-
* [
|
|
10
|
-
* [
|
|
11
|
-
* [
|
|
12
|
-
* [
|
|
8
|
+
* [get](#get) - Get template recipient
|
|
9
|
+
* [create](#create) - Create template recipient
|
|
10
|
+
* [createMany](#createmany) - Create template recipients
|
|
11
|
+
* [update](#update) - Update template recipient
|
|
12
|
+
* [updateMany](#updatemany) - Update template recipients
|
|
13
|
+
* [delete](#delete) - Delete template recipient
|
|
14
|
+
|
|
15
|
+
## get
|
|
16
|
+
|
|
17
|
+
Returns a single recipient. If you want to retrieve all the recipients for a template, use the "Get Template" endpoint.
|
|
18
|
+
|
|
19
|
+
### Example Usage
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { Documenso } from "@documenso/sdk-typescript";
|
|
23
|
+
|
|
24
|
+
const documenso = new Documenso({
|
|
25
|
+
apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
async function run() {
|
|
29
|
+
const result = await documenso.templates.recipients.get({
|
|
30
|
+
recipientId: 9814.04,
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
// Handle the result
|
|
34
|
+
console.log(result);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
run();
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Standalone function
|
|
41
|
+
|
|
42
|
+
The standalone function version of this method:
|
|
43
|
+
|
|
44
|
+
```typescript
|
|
45
|
+
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
46
|
+
import { templatesRecipientsGet } from "@documenso/sdk-typescript/funcs/templatesRecipientsGet.js";
|
|
47
|
+
|
|
48
|
+
// Use `DocumensoCore` for best tree-shaking performance.
|
|
49
|
+
// You can create one instance of it to use across an application.
|
|
50
|
+
const documenso = new DocumensoCore({
|
|
51
|
+
apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
|
|
52
|
+
});
|
|
53
|
+
|
|
54
|
+
async function run() {
|
|
55
|
+
const res = await templatesRecipientsGet(documenso, {
|
|
56
|
+
recipientId: 9814.04,
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
if (!res.ok) {
|
|
60
|
+
throw res.error;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
const { value: result } = res;
|
|
64
|
+
|
|
65
|
+
// Handle the result
|
|
66
|
+
console.log(result);
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
run();
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Parameters
|
|
73
|
+
|
|
74
|
+
| Parameter | Type | Required | Description |
|
|
75
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
76
|
+
| `request` | [operations.RecipientGetTemplateRecipientRequest](../../models/operations/recipientgettemplaterecipientrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
77
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
78
|
+
| `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. |
|
|
79
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
80
|
+
|
|
81
|
+
### Response
|
|
82
|
+
|
|
83
|
+
**Promise\<[operations.RecipientGetTemplateRecipientResponseBody](../../models/operations/recipientgettemplaterecipientresponsebody.md)\>**
|
|
84
|
+
|
|
85
|
+
### Errors
|
|
86
|
+
|
|
87
|
+
| Error Type | Status Code | Content Type |
|
|
88
|
+
| ------------------------------- | ------------------------------- | ------------------------------- |
|
|
89
|
+
| errors.ErrorBADREQUEST | 400 | application/json |
|
|
90
|
+
| errors.ErrorNOTFOUND | 404 | application/json |
|
|
91
|
+
| errors.Errorinternalservererror | 500 | application/json |
|
|
92
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
13
93
|
|
|
14
94
|
## create
|
|
15
95
|
|
|
16
|
-
Create a single recipient for a
|
|
96
|
+
Create a single recipient for a template.
|
|
17
97
|
|
|
18
98
|
### Example Usage
|
|
19
99
|
|
|
@@ -25,10 +105,10 @@ const documenso = new Documenso({
|
|
|
25
105
|
});
|
|
26
106
|
|
|
27
107
|
async function run() {
|
|
28
|
-
const result = await documenso.
|
|
29
|
-
|
|
108
|
+
const result = await documenso.templates.recipients.create({
|
|
109
|
+
templateId: 4865.89,
|
|
30
110
|
recipient: {
|
|
31
|
-
email: "
|
|
111
|
+
email: "Haylie_Bernhard95@yahoo.com",
|
|
32
112
|
name: "<value>",
|
|
33
113
|
role: "CC",
|
|
34
114
|
},
|
|
@@ -47,7 +127,7 @@ The standalone function version of this method:
|
|
|
47
127
|
|
|
48
128
|
```typescript
|
|
49
129
|
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
50
|
-
import {
|
|
130
|
+
import { templatesRecipientsCreate } from "@documenso/sdk-typescript/funcs/templatesRecipientsCreate.js";
|
|
51
131
|
|
|
52
132
|
// Use `DocumensoCore` for best tree-shaking performance.
|
|
53
133
|
// You can create one instance of it to use across an application.
|
|
@@ -56,10 +136,10 @@ const documenso = new DocumensoCore({
|
|
|
56
136
|
});
|
|
57
137
|
|
|
58
138
|
async function run() {
|
|
59
|
-
const res = await
|
|
60
|
-
|
|
139
|
+
const res = await templatesRecipientsCreate(documenso, {
|
|
140
|
+
templateId: 4865.89,
|
|
61
141
|
recipient: {
|
|
62
|
-
email: "
|
|
142
|
+
email: "Haylie_Bernhard95@yahoo.com",
|
|
63
143
|
name: "<value>",
|
|
64
144
|
role: "CC",
|
|
65
145
|
},
|
|
@@ -82,14 +162,14 @@ run();
|
|
|
82
162
|
|
|
83
163
|
| Parameter | Type | Required | Description |
|
|
84
164
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
85
|
-
| `request` | [operations.
|
|
165
|
+
| `request` | [operations.RecipientCreateTemplateRecipientRequestBody](../../models/operations/recipientcreatetemplaterecipientrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
86
166
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
87
167
|
| `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. |
|
|
88
168
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
89
169
|
|
|
90
170
|
### Response
|
|
91
171
|
|
|
92
|
-
**Promise\<[operations.
|
|
172
|
+
**Promise\<[operations.RecipientCreateTemplateRecipientResponseBody](../../models/operations/recipientcreatetemplaterecipientresponsebody.md)\>**
|
|
93
173
|
|
|
94
174
|
### Errors
|
|
95
175
|
|
|
@@ -101,7 +181,7 @@ run();
|
|
|
101
181
|
|
|
102
182
|
## createMany
|
|
103
183
|
|
|
104
|
-
Create multiple recipients for a
|
|
184
|
+
Create multiple recipients for a template.
|
|
105
185
|
|
|
106
186
|
### Example Usage
|
|
107
187
|
|
|
@@ -113,10 +193,19 @@ const documenso = new Documenso({
|
|
|
113
193
|
});
|
|
114
194
|
|
|
115
195
|
async function run() {
|
|
116
|
-
const result = await documenso.
|
|
117
|
-
|
|
196
|
+
const result = await documenso.templates.recipients.createMany({
|
|
197
|
+
templateId: 5158.41,
|
|
118
198
|
recipients: [
|
|
119
|
-
|
|
199
|
+
{
|
|
200
|
+
email: "Demetrius.Sanford35@hotmail.com",
|
|
201
|
+
name: "<value>",
|
|
202
|
+
role: "VIEWER",
|
|
203
|
+
},
|
|
204
|
+
{
|
|
205
|
+
email: "Lyla50@yahoo.com",
|
|
206
|
+
name: "<value>",
|
|
207
|
+
role: "APPROVER",
|
|
208
|
+
},
|
|
120
209
|
],
|
|
121
210
|
});
|
|
122
211
|
|
|
@@ -133,7 +222,7 @@ The standalone function version of this method:
|
|
|
133
222
|
|
|
134
223
|
```typescript
|
|
135
224
|
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
136
|
-
import {
|
|
225
|
+
import { templatesRecipientsCreateMany } from "@documenso/sdk-typescript/funcs/templatesRecipientsCreateMany.js";
|
|
137
226
|
|
|
138
227
|
// Use `DocumensoCore` for best tree-shaking performance.
|
|
139
228
|
// You can create one instance of it to use across an application.
|
|
@@ -142,10 +231,19 @@ const documenso = new DocumensoCore({
|
|
|
142
231
|
});
|
|
143
232
|
|
|
144
233
|
async function run() {
|
|
145
|
-
const res = await
|
|
146
|
-
|
|
234
|
+
const res = await templatesRecipientsCreateMany(documenso, {
|
|
235
|
+
templateId: 5158.41,
|
|
147
236
|
recipients: [
|
|
148
|
-
|
|
237
|
+
{
|
|
238
|
+
email: "Demetrius.Sanford35@hotmail.com",
|
|
239
|
+
name: "<value>",
|
|
240
|
+
role: "VIEWER",
|
|
241
|
+
},
|
|
242
|
+
{
|
|
243
|
+
email: "Lyla50@yahoo.com",
|
|
244
|
+
name: "<value>",
|
|
245
|
+
role: "APPROVER",
|
|
246
|
+
},
|
|
149
247
|
],
|
|
150
248
|
});
|
|
151
249
|
|
|
@@ -166,14 +264,14 @@ run();
|
|
|
166
264
|
|
|
167
265
|
| Parameter | Type | Required | Description |
|
|
168
266
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
169
|
-
| `request` | [operations.
|
|
267
|
+
| `request` | [operations.RecipientCreateTemplateRecipientsRequestBody](../../models/operations/recipientcreatetemplaterecipientsrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
170
268
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
171
269
|
| `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. |
|
|
172
270
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
173
271
|
|
|
174
272
|
### Response
|
|
175
273
|
|
|
176
|
-
**Promise\<[operations.
|
|
274
|
+
**Promise\<[operations.RecipientCreateTemplateRecipientsResponseBody](../../models/operations/recipientcreatetemplaterecipientsresponsebody.md)\>**
|
|
177
275
|
|
|
178
276
|
### Errors
|
|
179
277
|
|
|
@@ -185,7 +283,7 @@ run();
|
|
|
185
283
|
|
|
186
284
|
## update
|
|
187
285
|
|
|
188
|
-
Update a single recipient for a
|
|
286
|
+
Update a single recipient for a template.
|
|
189
287
|
|
|
190
288
|
### Example Usage
|
|
191
289
|
|
|
@@ -197,10 +295,10 @@ const documenso = new Documenso({
|
|
|
197
295
|
});
|
|
198
296
|
|
|
199
297
|
async function run() {
|
|
200
|
-
const result = await documenso.
|
|
201
|
-
|
|
298
|
+
const result = await documenso.templates.recipients.update({
|
|
299
|
+
templateId: 8574.78,
|
|
202
300
|
recipient: {
|
|
203
|
-
id:
|
|
301
|
+
id: 5971.29,
|
|
204
302
|
},
|
|
205
303
|
});
|
|
206
304
|
|
|
@@ -217,7 +315,7 @@ The standalone function version of this method:
|
|
|
217
315
|
|
|
218
316
|
```typescript
|
|
219
317
|
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
220
|
-
import {
|
|
318
|
+
import { templatesRecipientsUpdate } from "@documenso/sdk-typescript/funcs/templatesRecipientsUpdate.js";
|
|
221
319
|
|
|
222
320
|
// Use `DocumensoCore` for best tree-shaking performance.
|
|
223
321
|
// You can create one instance of it to use across an application.
|
|
@@ -226,10 +324,10 @@ const documenso = new DocumensoCore({
|
|
|
226
324
|
});
|
|
227
325
|
|
|
228
326
|
async function run() {
|
|
229
|
-
const res = await
|
|
230
|
-
|
|
327
|
+
const res = await templatesRecipientsUpdate(documenso, {
|
|
328
|
+
templateId: 8574.78,
|
|
231
329
|
recipient: {
|
|
232
|
-
id:
|
|
330
|
+
id: 5971.29,
|
|
233
331
|
},
|
|
234
332
|
});
|
|
235
333
|
|
|
@@ -250,14 +348,14 @@ run();
|
|
|
250
348
|
|
|
251
349
|
| Parameter | Type | Required | Description |
|
|
252
350
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
253
|
-
| `request` | [operations.
|
|
351
|
+
| `request` | [operations.RecipientUpdateTemplateRecipientRequestBody](../../models/operations/recipientupdatetemplaterecipientrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
254
352
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
255
353
|
| `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. |
|
|
256
354
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
257
355
|
|
|
258
356
|
### Response
|
|
259
357
|
|
|
260
|
-
**Promise\<[operations.
|
|
358
|
+
**Promise\<[operations.RecipientUpdateTemplateRecipientResponseBody](../../models/operations/recipientupdatetemplaterecipientresponsebody.md)\>**
|
|
261
359
|
|
|
262
360
|
### Errors
|
|
263
361
|
|
|
@@ -269,7 +367,7 @@ run();
|
|
|
269
367
|
|
|
270
368
|
## updateMany
|
|
271
369
|
|
|
272
|
-
Update multiple recipients for a
|
|
370
|
+
Update multiple recipients for a template.
|
|
273
371
|
|
|
274
372
|
### Example Usage
|
|
275
373
|
|
|
@@ -281,10 +379,15 @@ const documenso = new Documenso({
|
|
|
281
379
|
});
|
|
282
380
|
|
|
283
381
|
async function run() {
|
|
284
|
-
const result = await documenso.
|
|
285
|
-
|
|
382
|
+
const result = await documenso.templates.recipients.updateMany({
|
|
383
|
+
templateId: 4057.69,
|
|
286
384
|
recipients: [
|
|
287
|
-
|
|
385
|
+
{
|
|
386
|
+
id: 5359.16,
|
|
387
|
+
},
|
|
388
|
+
{
|
|
389
|
+
id: 8982.15,
|
|
390
|
+
},
|
|
288
391
|
],
|
|
289
392
|
});
|
|
290
393
|
|
|
@@ -301,7 +404,7 @@ The standalone function version of this method:
|
|
|
301
404
|
|
|
302
405
|
```typescript
|
|
303
406
|
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
304
|
-
import {
|
|
407
|
+
import { templatesRecipientsUpdateMany } from "@documenso/sdk-typescript/funcs/templatesRecipientsUpdateMany.js";
|
|
305
408
|
|
|
306
409
|
// Use `DocumensoCore` for best tree-shaking performance.
|
|
307
410
|
// You can create one instance of it to use across an application.
|
|
@@ -310,10 +413,15 @@ const documenso = new DocumensoCore({
|
|
|
310
413
|
});
|
|
311
414
|
|
|
312
415
|
async function run() {
|
|
313
|
-
const res = await
|
|
314
|
-
|
|
416
|
+
const res = await templatesRecipientsUpdateMany(documenso, {
|
|
417
|
+
templateId: 4057.69,
|
|
315
418
|
recipients: [
|
|
316
|
-
|
|
419
|
+
{
|
|
420
|
+
id: 5359.16,
|
|
421
|
+
},
|
|
422
|
+
{
|
|
423
|
+
id: 8982.15,
|
|
424
|
+
},
|
|
317
425
|
],
|
|
318
426
|
});
|
|
319
427
|
|
|
@@ -334,14 +442,14 @@ run();
|
|
|
334
442
|
|
|
335
443
|
| Parameter | Type | Required | Description |
|
|
336
444
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
337
|
-
| `request` | [operations.
|
|
445
|
+
| `request` | [operations.RecipientUpdateTemplateRecipientsRequestBody](../../models/operations/recipientupdatetemplaterecipientsrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
338
446
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
339
447
|
| `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. |
|
|
340
448
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
341
449
|
|
|
342
450
|
### Response
|
|
343
451
|
|
|
344
|
-
**Promise\<[operations.
|
|
452
|
+
**Promise\<[operations.RecipientUpdateTemplateRecipientsResponseBody](../../models/operations/recipientupdatetemplaterecipientsresponsebody.md)\>**
|
|
345
453
|
|
|
346
454
|
### Errors
|
|
347
455
|
|
|
@@ -353,7 +461,7 @@ run();
|
|
|
353
461
|
|
|
354
462
|
## delete
|
|
355
463
|
|
|
356
|
-
Delete
|
|
464
|
+
Delete template recipient
|
|
357
465
|
|
|
358
466
|
### Example Usage
|
|
359
467
|
|
|
@@ -365,8 +473,8 @@ const documenso = new Documenso({
|
|
|
365
473
|
});
|
|
366
474
|
|
|
367
475
|
async function run() {
|
|
368
|
-
const result = await documenso.
|
|
369
|
-
recipientId:
|
|
476
|
+
const result = await documenso.templates.recipients.delete({
|
|
477
|
+
recipientId: 5459.07,
|
|
370
478
|
});
|
|
371
479
|
|
|
372
480
|
// Handle the result
|
|
@@ -382,7 +490,7 @@ The standalone function version of this method:
|
|
|
382
490
|
|
|
383
491
|
```typescript
|
|
384
492
|
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
385
|
-
import {
|
|
493
|
+
import { templatesRecipientsDelete } from "@documenso/sdk-typescript/funcs/templatesRecipientsDelete.js";
|
|
386
494
|
|
|
387
495
|
// Use `DocumensoCore` for best tree-shaking performance.
|
|
388
496
|
// You can create one instance of it to use across an application.
|
|
@@ -391,8 +499,8 @@ const documenso = new DocumensoCore({
|
|
|
391
499
|
});
|
|
392
500
|
|
|
393
501
|
async function run() {
|
|
394
|
-
const res = await
|
|
395
|
-
recipientId:
|
|
502
|
+
const res = await templatesRecipientsDelete(documenso, {
|
|
503
|
+
recipientId: 5459.07,
|
|
396
504
|
});
|
|
397
505
|
|
|
398
506
|
if (!res.ok) {
|
|
@@ -412,14 +520,14 @@ run();
|
|
|
412
520
|
|
|
413
521
|
| Parameter | Type | Required | Description |
|
|
414
522
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
415
|
-
| `request` | [operations.
|
|
523
|
+
| `request` | [operations.RecipientDeleteTemplateRecipientRequestBody](../../models/operations/recipientdeletetemplaterecipientrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
416
524
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
417
525
|
| `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. |
|
|
418
526
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
419
527
|
|
|
420
528
|
### Response
|
|
421
529
|
|
|
422
|
-
**Promise\<[
|
|
530
|
+
**Promise\<[operations.RecipientDeleteTemplateRecipientResponseBody](../../models/operations/recipientdeletetemplaterecipientresponsebody.md)\>**
|
|
423
531
|
|
|
424
532
|
### Errors
|
|
425
533
|
|
|
@@ -29,7 +29,9 @@ const documenso = new Documenso({
|
|
|
29
29
|
});
|
|
30
30
|
|
|
31
31
|
async function run() {
|
|
32
|
-
const result = await documenso.documents.find({
|
|
32
|
+
const result = await documenso.documents.find({
|
|
33
|
+
orderByDirection: "desc",
|
|
34
|
+
});
|
|
33
35
|
|
|
34
36
|
// Handle the result
|
|
35
37
|
console.log(result);
|
|
@@ -53,7 +55,9 @@ const documenso = new DocumensoCore({
|
|
|
53
55
|
});
|
|
54
56
|
|
|
55
57
|
async function run() {
|
|
56
|
-
const res = await documentsFind(documenso, {
|
|
58
|
+
const res = await documentsFind(documenso, {
|
|
59
|
+
orderByDirection: "desc",
|
|
60
|
+
});
|
|
57
61
|
|
|
58
62
|
if (!res.ok) {
|
|
59
63
|
throw res.error;
|
|
@@ -105,7 +109,7 @@ const documenso = new Documenso({
|
|
|
105
109
|
|
|
106
110
|
async function run() {
|
|
107
111
|
const result = await documenso.documents.get({
|
|
108
|
-
documentId:
|
|
112
|
+
documentId: 7003.47,
|
|
109
113
|
});
|
|
110
114
|
|
|
111
115
|
// Handle the result
|
|
@@ -131,7 +135,7 @@ const documenso = new DocumensoCore({
|
|
|
131
135
|
|
|
132
136
|
async function run() {
|
|
133
137
|
const res = await documentsGet(documenso, {
|
|
134
|
-
documentId:
|
|
138
|
+
documentId: 7003.47,
|
|
135
139
|
});
|
|
136
140
|
|
|
137
141
|
if (!res.ok) {
|
|
@@ -262,7 +266,7 @@ const documenso = new Documenso({
|
|
|
262
266
|
|
|
263
267
|
async function run() {
|
|
264
268
|
const result = await documenso.documents.update({
|
|
265
|
-
documentId:
|
|
269
|
+
documentId: 8574.78,
|
|
266
270
|
});
|
|
267
271
|
|
|
268
272
|
// Handle the result
|
|
@@ -288,7 +292,7 @@ const documenso = new DocumensoCore({
|
|
|
288
292
|
|
|
289
293
|
async function run() {
|
|
290
294
|
const res = await documentsUpdate(documenso, {
|
|
291
|
-
documentId:
|
|
295
|
+
documentId: 8574.78,
|
|
292
296
|
});
|
|
293
297
|
|
|
294
298
|
if (!res.ok) {
|
|
@@ -340,7 +344,7 @@ const documenso = new Documenso({
|
|
|
340
344
|
|
|
341
345
|
async function run() {
|
|
342
346
|
const result = await documenso.documents.delete({
|
|
343
|
-
documentId:
|
|
347
|
+
documentId: 5459.07,
|
|
344
348
|
});
|
|
345
349
|
|
|
346
350
|
// Handle the result
|
|
@@ -366,7 +370,7 @@ const documenso = new DocumensoCore({
|
|
|
366
370
|
|
|
367
371
|
async function run() {
|
|
368
372
|
const res = await documentsDelete(documenso, {
|
|
369
|
-
documentId:
|
|
373
|
+
documentId: 5459.07,
|
|
370
374
|
});
|
|
371
375
|
|
|
372
376
|
if (!res.ok) {
|
|
@@ -393,7 +397,7 @@ run();
|
|
|
393
397
|
|
|
394
398
|
### Response
|
|
395
399
|
|
|
396
|
-
**Promise\<[
|
|
400
|
+
**Promise\<[operations.DocumentDeleteDocumentResponseBody](../../models/operations/documentdeletedocumentresponsebody.md)\>**
|
|
397
401
|
|
|
398
402
|
### Errors
|
|
399
403
|
|
|
@@ -418,8 +422,8 @@ const documenso = new Documenso({
|
|
|
418
422
|
|
|
419
423
|
async function run() {
|
|
420
424
|
const result = await documenso.documents.moveToTeam({
|
|
421
|
-
documentId:
|
|
422
|
-
teamId:
|
|
425
|
+
documentId: 8301.72,
|
|
426
|
+
teamId: 6724.78,
|
|
423
427
|
});
|
|
424
428
|
|
|
425
429
|
// Handle the result
|
|
@@ -445,8 +449,8 @@ const documenso = new DocumensoCore({
|
|
|
445
449
|
|
|
446
450
|
async function run() {
|
|
447
451
|
const res = await documentsMoveToTeam(documenso, {
|
|
448
|
-
documentId:
|
|
449
|
-
teamId:
|
|
452
|
+
documentId: 8301.72,
|
|
453
|
+
teamId: 6724.78,
|
|
450
454
|
});
|
|
451
455
|
|
|
452
456
|
if (!res.ok) {
|
|
@@ -498,7 +502,7 @@ const documenso = new Documenso({
|
|
|
498
502
|
|
|
499
503
|
async function run() {
|
|
500
504
|
const result = await documenso.documents.distribute({
|
|
501
|
-
documentId:
|
|
505
|
+
documentId: 4115.92,
|
|
502
506
|
});
|
|
503
507
|
|
|
504
508
|
// Handle the result
|
|
@@ -524,7 +528,7 @@ const documenso = new DocumensoCore({
|
|
|
524
528
|
|
|
525
529
|
async function run() {
|
|
526
530
|
const res = await documentsDistribute(documenso, {
|
|
527
|
-
documentId:
|
|
531
|
+
documentId: 4115.92,
|
|
528
532
|
});
|
|
529
533
|
|
|
530
534
|
if (!res.ok) {
|
|
@@ -576,9 +580,9 @@ const documenso = new Documenso({
|
|
|
576
580
|
|
|
577
581
|
async function run() {
|
|
578
582
|
const result = await documenso.documents.redistribute({
|
|
579
|
-
documentId:
|
|
583
|
+
documentId: 5758.65,
|
|
580
584
|
recipients: [
|
|
581
|
-
|
|
585
|
+
|
|
582
586
|
],
|
|
583
587
|
});
|
|
584
588
|
|
|
@@ -605,9 +609,9 @@ const documenso = new DocumensoCore({
|
|
|
605
609
|
|
|
606
610
|
async function run() {
|
|
607
611
|
const res = await documentsRedistribute(documenso, {
|
|
608
|
-
documentId:
|
|
612
|
+
documentId: 5758.65,
|
|
609
613
|
recipients: [
|
|
610
|
-
|
|
614
|
+
|
|
611
615
|
],
|
|
612
616
|
});
|
|
613
617
|
|
|
@@ -635,7 +639,7 @@ run();
|
|
|
635
639
|
|
|
636
640
|
### Response
|
|
637
641
|
|
|
638
|
-
**Promise\<[
|
|
642
|
+
**Promise\<[operations.DocumentResendDocumentResponseBody](../../models/operations/documentresenddocumentresponsebody.md)\>**
|
|
639
643
|
|
|
640
644
|
### Errors
|
|
641
645
|
|
|
@@ -660,7 +664,7 @@ const documenso = new Documenso({
|
|
|
660
664
|
|
|
661
665
|
async function run() {
|
|
662
666
|
const result = await documenso.documents.duplicate({
|
|
663
|
-
documentId:
|
|
667
|
+
documentId: 3523.11,
|
|
664
668
|
});
|
|
665
669
|
|
|
666
670
|
// Handle the result
|
|
@@ -686,7 +690,7 @@ const documenso = new DocumensoCore({
|
|
|
686
690
|
|
|
687
691
|
async function run() {
|
|
688
692
|
const res = await documentsDuplicate(documenso, {
|
|
689
|
-
documentId:
|
|
693
|
+
documentId: 3523.11,
|
|
690
694
|
});
|
|
691
695
|
|
|
692
696
|
if (!res.ok) {
|