@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,20 @@
|
|
|
1
1
|
# DocumensoFields
|
|
2
|
-
(*
|
|
2
|
+
(*templates.fields*)
|
|
3
3
|
|
|
4
4
|
## Overview
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
-
* [create](#create) - Create
|
|
9
|
-
* [
|
|
10
|
-
* [
|
|
11
|
-
* [
|
|
12
|
-
* [
|
|
8
|
+
* [create](#create) - Create template field
|
|
9
|
+
* [get](#get) - Get template field
|
|
10
|
+
* [createMany](#createmany) - Create template fields
|
|
11
|
+
* [update](#update) - Update template field
|
|
12
|
+
* [updateMany](#updatemany) - Update template fields
|
|
13
|
+
* [delete](#delete) - Delete template field
|
|
13
14
|
|
|
14
15
|
## create
|
|
15
16
|
|
|
16
|
-
Create a single field for a
|
|
17
|
+
Create a single field for a template.
|
|
17
18
|
|
|
18
19
|
### Example Usage
|
|
19
20
|
|
|
@@ -25,16 +26,16 @@ const documenso = new Documenso({
|
|
|
25
26
|
});
|
|
26
27
|
|
|
27
28
|
async function run() {
|
|
28
|
-
const result = await documenso.
|
|
29
|
-
|
|
29
|
+
const result = await documenso.templates.fields.create({
|
|
30
|
+
templateId: 4865.89,
|
|
30
31
|
field: {
|
|
31
|
-
type: "
|
|
32
|
-
recipientId:
|
|
33
|
-
pageNumber:
|
|
34
|
-
pageX:
|
|
35
|
-
pageY:
|
|
36
|
-
width:
|
|
37
|
-
height:
|
|
32
|
+
type: "NUMBER",
|
|
33
|
+
recipientId: 4174.58,
|
|
34
|
+
pageNumber: 1343.65,
|
|
35
|
+
pageX: 690.25,
|
|
36
|
+
pageY: 7964.74,
|
|
37
|
+
width: 9510.62,
|
|
38
|
+
height: 0.86,
|
|
38
39
|
},
|
|
39
40
|
});
|
|
40
41
|
|
|
@@ -51,7 +52,7 @@ The standalone function version of this method:
|
|
|
51
52
|
|
|
52
53
|
```typescript
|
|
53
54
|
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
54
|
-
import {
|
|
55
|
+
import { templatesFieldsCreate } from "@documenso/sdk-typescript/funcs/templatesFieldsCreate.js";
|
|
55
56
|
|
|
56
57
|
// Use `DocumensoCore` for best tree-shaking performance.
|
|
57
58
|
// You can create one instance of it to use across an application.
|
|
@@ -60,16 +61,16 @@ const documenso = new DocumensoCore({
|
|
|
60
61
|
});
|
|
61
62
|
|
|
62
63
|
async function run() {
|
|
63
|
-
const res = await
|
|
64
|
-
|
|
64
|
+
const res = await templatesFieldsCreate(documenso, {
|
|
65
|
+
templateId: 4865.89,
|
|
65
66
|
field: {
|
|
66
|
-
type: "
|
|
67
|
-
recipientId:
|
|
68
|
-
pageNumber:
|
|
69
|
-
pageX:
|
|
70
|
-
pageY:
|
|
71
|
-
width:
|
|
72
|
-
height:
|
|
67
|
+
type: "NUMBER",
|
|
68
|
+
recipientId: 4174.58,
|
|
69
|
+
pageNumber: 1343.65,
|
|
70
|
+
pageX: 690.25,
|
|
71
|
+
pageY: 7964.74,
|
|
72
|
+
width: 9510.62,
|
|
73
|
+
height: 0.86,
|
|
73
74
|
},
|
|
74
75
|
});
|
|
75
76
|
|
|
@@ -90,14 +91,14 @@ run();
|
|
|
90
91
|
|
|
91
92
|
| Parameter | Type | Required | Description |
|
|
92
93
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
93
|
-
| `request` | [operations.
|
|
94
|
+
| `request` | [operations.FieldCreateTemplateFieldRequestBody](../../models/operations/fieldcreatetemplatefieldrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
94
95
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
95
96
|
| `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. |
|
|
96
97
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
97
98
|
|
|
98
99
|
### Response
|
|
99
100
|
|
|
100
|
-
**Promise\<[operations.
|
|
101
|
+
**Promise\<[operations.FieldCreateTemplateFieldResponseBody](../../models/operations/fieldcreatetemplatefieldresponsebody.md)\>**
|
|
101
102
|
|
|
102
103
|
### Errors
|
|
103
104
|
|
|
@@ -107,9 +108,88 @@ run();
|
|
|
107
108
|
| errors.Errorinternalservererror | 500 | application/json |
|
|
108
109
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
109
110
|
|
|
111
|
+
## get
|
|
112
|
+
|
|
113
|
+
Returns a single field. If you want to retrieve all the fields for a template, use the "Get Template" endpoint.
|
|
114
|
+
|
|
115
|
+
### Example Usage
|
|
116
|
+
|
|
117
|
+
```typescript
|
|
118
|
+
import { Documenso } from "@documenso/sdk-typescript";
|
|
119
|
+
|
|
120
|
+
const documenso = new Documenso({
|
|
121
|
+
apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
|
|
122
|
+
});
|
|
123
|
+
|
|
124
|
+
async function run() {
|
|
125
|
+
const result = await documenso.templates.fields.get({
|
|
126
|
+
fieldId: 1340.63,
|
|
127
|
+
});
|
|
128
|
+
|
|
129
|
+
// Handle the result
|
|
130
|
+
console.log(result);
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
run();
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### Standalone function
|
|
137
|
+
|
|
138
|
+
The standalone function version of this method:
|
|
139
|
+
|
|
140
|
+
```typescript
|
|
141
|
+
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
142
|
+
import { templatesFieldsGet } from "@documenso/sdk-typescript/funcs/templatesFieldsGet.js";
|
|
143
|
+
|
|
144
|
+
// Use `DocumensoCore` for best tree-shaking performance.
|
|
145
|
+
// You can create one instance of it to use across an application.
|
|
146
|
+
const documenso = new DocumensoCore({
|
|
147
|
+
apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
|
|
148
|
+
});
|
|
149
|
+
|
|
150
|
+
async function run() {
|
|
151
|
+
const res = await templatesFieldsGet(documenso, {
|
|
152
|
+
fieldId: 1340.63,
|
|
153
|
+
});
|
|
154
|
+
|
|
155
|
+
if (!res.ok) {
|
|
156
|
+
throw res.error;
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
const { value: result } = res;
|
|
160
|
+
|
|
161
|
+
// Handle the result
|
|
162
|
+
console.log(result);
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
run();
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
### Parameters
|
|
169
|
+
|
|
170
|
+
| Parameter | Type | Required | Description |
|
|
171
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
172
|
+
| `request` | [operations.FieldGetTemplateFieldRequest](../../models/operations/fieldgettemplatefieldrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
173
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
174
|
+
| `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. |
|
|
175
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
176
|
+
|
|
177
|
+
### Response
|
|
178
|
+
|
|
179
|
+
**Promise\<[operations.FieldGetTemplateFieldResponseBody](../../models/operations/fieldgettemplatefieldresponsebody.md)\>**
|
|
180
|
+
|
|
181
|
+
### Errors
|
|
182
|
+
|
|
183
|
+
| Error Type | Status Code | Content Type |
|
|
184
|
+
| ------------------------------- | ------------------------------- | ------------------------------- |
|
|
185
|
+
| errors.ErrorBADREQUEST | 400 | application/json |
|
|
186
|
+
| errors.ErrorNOTFOUND | 404 | application/json |
|
|
187
|
+
| errors.Errorinternalservererror | 500 | application/json |
|
|
188
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
189
|
+
|
|
110
190
|
## createMany
|
|
111
191
|
|
|
112
|
-
Create multiple fields for a
|
|
192
|
+
Create multiple fields for a template.
|
|
113
193
|
|
|
114
194
|
### Example Usage
|
|
115
195
|
|
|
@@ -121,26 +201,26 @@ const documenso = new Documenso({
|
|
|
121
201
|
});
|
|
122
202
|
|
|
123
203
|
async function run() {
|
|
124
|
-
const result = await documenso.
|
|
125
|
-
|
|
204
|
+
const result = await documenso.templates.fields.createMany({
|
|
205
|
+
templateId: 5158.41,
|
|
126
206
|
fields: [
|
|
127
207
|
{
|
|
128
|
-
type: "
|
|
129
|
-
recipientId:
|
|
130
|
-
pageNumber:
|
|
131
|
-
pageX:
|
|
132
|
-
pageY:
|
|
133
|
-
width:
|
|
134
|
-
height:
|
|
208
|
+
type: "CHECKBOX",
|
|
209
|
+
recipientId: 2516.72,
|
|
210
|
+
pageNumber: 2304.17,
|
|
211
|
+
pageX: 7760.32,
|
|
212
|
+
pageY: 3376.66,
|
|
213
|
+
width: 3566.94,
|
|
214
|
+
height: 2768.94,
|
|
135
215
|
},
|
|
136
216
|
{
|
|
137
|
-
type: "
|
|
138
|
-
recipientId:
|
|
139
|
-
pageNumber:
|
|
140
|
-
pageX:
|
|
141
|
-
pageY:
|
|
142
|
-
width:
|
|
143
|
-
height:
|
|
217
|
+
type: "NUMBER",
|
|
218
|
+
recipientId: 5689.64,
|
|
219
|
+
pageNumber: 6483.69,
|
|
220
|
+
pageX: 7271.79,
|
|
221
|
+
pageY: 1891.56,
|
|
222
|
+
width: 7263.21,
|
|
223
|
+
height: 5043.41,
|
|
144
224
|
},
|
|
145
225
|
],
|
|
146
226
|
});
|
|
@@ -158,7 +238,7 @@ The standalone function version of this method:
|
|
|
158
238
|
|
|
159
239
|
```typescript
|
|
160
240
|
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
161
|
-
import {
|
|
241
|
+
import { templatesFieldsCreateMany } from "@documenso/sdk-typescript/funcs/templatesFieldsCreateMany.js";
|
|
162
242
|
|
|
163
243
|
// Use `DocumensoCore` for best tree-shaking performance.
|
|
164
244
|
// You can create one instance of it to use across an application.
|
|
@@ -167,26 +247,26 @@ const documenso = new DocumensoCore({
|
|
|
167
247
|
});
|
|
168
248
|
|
|
169
249
|
async function run() {
|
|
170
|
-
const res = await
|
|
171
|
-
|
|
250
|
+
const res = await templatesFieldsCreateMany(documenso, {
|
|
251
|
+
templateId: 5158.41,
|
|
172
252
|
fields: [
|
|
173
253
|
{
|
|
174
|
-
type: "
|
|
175
|
-
recipientId:
|
|
176
|
-
pageNumber:
|
|
177
|
-
pageX:
|
|
178
|
-
pageY:
|
|
179
|
-
width:
|
|
180
|
-
height:
|
|
254
|
+
type: "CHECKBOX",
|
|
255
|
+
recipientId: 2516.72,
|
|
256
|
+
pageNumber: 2304.17,
|
|
257
|
+
pageX: 7760.32,
|
|
258
|
+
pageY: 3376.66,
|
|
259
|
+
width: 3566.94,
|
|
260
|
+
height: 2768.94,
|
|
181
261
|
},
|
|
182
262
|
{
|
|
183
|
-
type: "
|
|
184
|
-
recipientId:
|
|
185
|
-
pageNumber:
|
|
186
|
-
pageX:
|
|
187
|
-
pageY:
|
|
188
|
-
width:
|
|
189
|
-
height:
|
|
263
|
+
type: "NUMBER",
|
|
264
|
+
recipientId: 5689.64,
|
|
265
|
+
pageNumber: 6483.69,
|
|
266
|
+
pageX: 7271.79,
|
|
267
|
+
pageY: 1891.56,
|
|
268
|
+
width: 7263.21,
|
|
269
|
+
height: 5043.41,
|
|
190
270
|
},
|
|
191
271
|
],
|
|
192
272
|
});
|
|
@@ -208,14 +288,14 @@ run();
|
|
|
208
288
|
|
|
209
289
|
| Parameter | Type | Required | Description |
|
|
210
290
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
211
|
-
| `request` | [operations.
|
|
291
|
+
| `request` | [operations.FieldCreateTemplateFieldsRequestBody](../../models/operations/fieldcreatetemplatefieldsrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
212
292
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
213
293
|
| `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. |
|
|
214
294
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
215
295
|
|
|
216
296
|
### Response
|
|
217
297
|
|
|
218
|
-
**Promise\<[operations.
|
|
298
|
+
**Promise\<[operations.FieldCreateTemplateFieldsResponseBody](../../models/operations/fieldcreatetemplatefieldsresponsebody.md)\>**
|
|
219
299
|
|
|
220
300
|
### Errors
|
|
221
301
|
|
|
@@ -227,7 +307,7 @@ run();
|
|
|
227
307
|
|
|
228
308
|
## update
|
|
229
309
|
|
|
230
|
-
Update a single field for a
|
|
310
|
+
Update a single field for a template.
|
|
231
311
|
|
|
232
312
|
### Example Usage
|
|
233
313
|
|
|
@@ -239,11 +319,11 @@ const documenso = new Documenso({
|
|
|
239
319
|
});
|
|
240
320
|
|
|
241
321
|
async function run() {
|
|
242
|
-
const result = await documenso.
|
|
243
|
-
|
|
322
|
+
const result = await documenso.templates.fields.update({
|
|
323
|
+
templateId: 8574.78,
|
|
244
324
|
field: {
|
|
245
|
-
type: "
|
|
246
|
-
id:
|
|
325
|
+
type: "TEXT",
|
|
326
|
+
id: 3446.2,
|
|
247
327
|
},
|
|
248
328
|
});
|
|
249
329
|
|
|
@@ -260,7 +340,7 @@ The standalone function version of this method:
|
|
|
260
340
|
|
|
261
341
|
```typescript
|
|
262
342
|
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
263
|
-
import {
|
|
343
|
+
import { templatesFieldsUpdate } from "@documenso/sdk-typescript/funcs/templatesFieldsUpdate.js";
|
|
264
344
|
|
|
265
345
|
// Use `DocumensoCore` for best tree-shaking performance.
|
|
266
346
|
// You can create one instance of it to use across an application.
|
|
@@ -269,11 +349,11 @@ const documenso = new DocumensoCore({
|
|
|
269
349
|
});
|
|
270
350
|
|
|
271
351
|
async function run() {
|
|
272
|
-
const res = await
|
|
273
|
-
|
|
352
|
+
const res = await templatesFieldsUpdate(documenso, {
|
|
353
|
+
templateId: 8574.78,
|
|
274
354
|
field: {
|
|
275
|
-
type: "
|
|
276
|
-
id:
|
|
355
|
+
type: "TEXT",
|
|
356
|
+
id: 3446.2,
|
|
277
357
|
},
|
|
278
358
|
});
|
|
279
359
|
|
|
@@ -294,14 +374,14 @@ run();
|
|
|
294
374
|
|
|
295
375
|
| Parameter | Type | Required | Description |
|
|
296
376
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
297
|
-
| `request` | [operations.
|
|
377
|
+
| `request` | [operations.FieldUpdateTemplateFieldRequestBody](../../models/operations/fieldupdatetemplatefieldrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
298
378
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
299
379
|
| `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. |
|
|
300
380
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
301
381
|
|
|
302
382
|
### Response
|
|
303
383
|
|
|
304
|
-
**Promise\<[operations.
|
|
384
|
+
**Promise\<[operations.FieldUpdateTemplateFieldResponseBody](../../models/operations/fieldupdatetemplatefieldresponsebody.md)\>**
|
|
305
385
|
|
|
306
386
|
### Errors
|
|
307
387
|
|
|
@@ -313,7 +393,7 @@ run();
|
|
|
313
393
|
|
|
314
394
|
## updateMany
|
|
315
395
|
|
|
316
|
-
Update multiple fields for a
|
|
396
|
+
Update multiple fields for a template.
|
|
317
397
|
|
|
318
398
|
### Example Usage
|
|
319
399
|
|
|
@@ -325,12 +405,16 @@ const documenso = new Documenso({
|
|
|
325
405
|
});
|
|
326
406
|
|
|
327
407
|
async function run() {
|
|
328
|
-
const result = await documenso.
|
|
329
|
-
|
|
408
|
+
const result = await documenso.templates.fields.updateMany({
|
|
409
|
+
templateId: 4057.69,
|
|
330
410
|
fields: [
|
|
331
411
|
{
|
|
332
|
-
type: "
|
|
333
|
-
id:
|
|
412
|
+
type: "DATE",
|
|
413
|
+
id: 8982.15,
|
|
414
|
+
},
|
|
415
|
+
{
|
|
416
|
+
type: "NAME",
|
|
417
|
+
id: 310.19,
|
|
334
418
|
},
|
|
335
419
|
],
|
|
336
420
|
});
|
|
@@ -348,7 +432,7 @@ The standalone function version of this method:
|
|
|
348
432
|
|
|
349
433
|
```typescript
|
|
350
434
|
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
351
|
-
import {
|
|
435
|
+
import { templatesFieldsUpdateMany } from "@documenso/sdk-typescript/funcs/templatesFieldsUpdateMany.js";
|
|
352
436
|
|
|
353
437
|
// Use `DocumensoCore` for best tree-shaking performance.
|
|
354
438
|
// You can create one instance of it to use across an application.
|
|
@@ -357,12 +441,16 @@ const documenso = new DocumensoCore({
|
|
|
357
441
|
});
|
|
358
442
|
|
|
359
443
|
async function run() {
|
|
360
|
-
const res = await
|
|
361
|
-
|
|
444
|
+
const res = await templatesFieldsUpdateMany(documenso, {
|
|
445
|
+
templateId: 4057.69,
|
|
362
446
|
fields: [
|
|
363
447
|
{
|
|
364
|
-
type: "
|
|
365
|
-
id:
|
|
448
|
+
type: "DATE",
|
|
449
|
+
id: 8982.15,
|
|
450
|
+
},
|
|
451
|
+
{
|
|
452
|
+
type: "NAME",
|
|
453
|
+
id: 310.19,
|
|
366
454
|
},
|
|
367
455
|
],
|
|
368
456
|
});
|
|
@@ -384,14 +472,14 @@ run();
|
|
|
384
472
|
|
|
385
473
|
| Parameter | Type | Required | Description |
|
|
386
474
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
387
|
-
| `request` | [operations.
|
|
475
|
+
| `request` | [operations.FieldUpdateTemplateFieldsRequestBody](../../models/operations/fieldupdatetemplatefieldsrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
388
476
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
389
477
|
| `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. |
|
|
390
478
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
391
479
|
|
|
392
480
|
### Response
|
|
393
481
|
|
|
394
|
-
**Promise\<[operations.
|
|
482
|
+
**Promise\<[operations.FieldUpdateTemplateFieldsResponseBody](../../models/operations/fieldupdatetemplatefieldsresponsebody.md)\>**
|
|
395
483
|
|
|
396
484
|
### Errors
|
|
397
485
|
|
|
@@ -403,7 +491,7 @@ run();
|
|
|
403
491
|
|
|
404
492
|
## delete
|
|
405
493
|
|
|
406
|
-
Delete
|
|
494
|
+
Delete template field
|
|
407
495
|
|
|
408
496
|
### Example Usage
|
|
409
497
|
|
|
@@ -415,8 +503,8 @@ const documenso = new Documenso({
|
|
|
415
503
|
});
|
|
416
504
|
|
|
417
505
|
async function run() {
|
|
418
|
-
const result = await documenso.
|
|
419
|
-
fieldId:
|
|
506
|
+
const result = await documenso.templates.fields.delete({
|
|
507
|
+
fieldId: 5459.07,
|
|
420
508
|
});
|
|
421
509
|
|
|
422
510
|
// Handle the result
|
|
@@ -432,7 +520,7 @@ The standalone function version of this method:
|
|
|
432
520
|
|
|
433
521
|
```typescript
|
|
434
522
|
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
435
|
-
import {
|
|
523
|
+
import { templatesFieldsDelete } from "@documenso/sdk-typescript/funcs/templatesFieldsDelete.js";
|
|
436
524
|
|
|
437
525
|
// Use `DocumensoCore` for best tree-shaking performance.
|
|
438
526
|
// You can create one instance of it to use across an application.
|
|
@@ -441,8 +529,8 @@ const documenso = new DocumensoCore({
|
|
|
441
529
|
});
|
|
442
530
|
|
|
443
531
|
async function run() {
|
|
444
|
-
const res = await
|
|
445
|
-
fieldId:
|
|
532
|
+
const res = await templatesFieldsDelete(documenso, {
|
|
533
|
+
fieldId: 5459.07,
|
|
446
534
|
});
|
|
447
535
|
|
|
448
536
|
if (!res.ok) {
|
|
@@ -462,14 +550,14 @@ run();
|
|
|
462
550
|
|
|
463
551
|
| Parameter | Type | Required | Description |
|
|
464
552
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
465
|
-
| `request` | [operations.
|
|
553
|
+
| `request` | [operations.FieldDeleteTemplateFieldRequestBody](../../models/operations/fielddeletetemplatefieldrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
466
554
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
467
555
|
| `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. |
|
|
468
556
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
469
557
|
|
|
470
558
|
### Response
|
|
471
559
|
|
|
472
|
-
**Promise\<[
|
|
560
|
+
**Promise\<[operations.FieldDeleteTemplateFieldResponseBody](../../models/operations/fielddeletetemplatefieldresponsebody.md)\>**
|
|
473
561
|
|
|
474
562
|
### Errors
|
|
475
563
|
|