@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.
Files changed (211) hide show
  1. package/FUNCTIONS.md +3 -1
  2. package/README.md +76 -69
  3. package/docs/sdks/directlink/README.md +7 -7
  4. package/docs/sdks/documensofields/README.md +184 -96
  5. package/docs/sdks/documensorecipients/README.md +162 -54
  6. package/docs/sdks/documents/README.md +26 -22
  7. package/docs/sdks/fields/README.md +491 -10
  8. package/docs/sdks/recipients/README.md +461 -10
  9. package/docs/sdks/templates/README.md +31 -17
  10. package/funcs/documentsDelete.d.ts +1 -1
  11. package/funcs/documentsDelete.d.ts.map +1 -1
  12. package/funcs/documentsDelete.js +1 -2
  13. package/funcs/documentsDelete.js.map +1 -1
  14. package/funcs/documentsFieldsDelete.d.ts +1 -1
  15. package/funcs/documentsFieldsDelete.d.ts.map +1 -1
  16. package/funcs/documentsFieldsDelete.js +1 -2
  17. package/funcs/documentsFieldsDelete.js.map +1 -1
  18. package/funcs/{fieldsGet.d.ts → documentsFieldsGet.d.ts} +4 -4
  19. package/funcs/documentsFieldsGet.d.ts.map +1 -0
  20. package/funcs/{recipientsGet.js → documentsFieldsGet.js} +10 -10
  21. package/funcs/documentsFieldsGet.js.map +1 -0
  22. package/funcs/documentsRecipientsDelete.d.ts +1 -1
  23. package/funcs/documentsRecipientsDelete.d.ts.map +1 -1
  24. package/funcs/documentsRecipientsDelete.js +1 -2
  25. package/funcs/documentsRecipientsDelete.js.map +1 -1
  26. package/funcs/{recipientsGet.d.ts → documentsRecipientsGet.d.ts} +4 -4
  27. package/funcs/documentsRecipientsGet.d.ts.map +1 -0
  28. package/funcs/documentsRecipientsGet.js +116 -0
  29. package/funcs/documentsRecipientsGet.js.map +1 -0
  30. package/funcs/documentsRedistribute.d.ts +1 -1
  31. package/funcs/documentsRedistribute.d.ts.map +1 -1
  32. package/funcs/documentsRedistribute.js +1 -2
  33. package/funcs/documentsRedistribute.js.map +1 -1
  34. package/funcs/templatesDelete.d.ts +1 -1
  35. package/funcs/templatesDelete.d.ts.map +1 -1
  36. package/funcs/templatesDelete.js +1 -2
  37. package/funcs/templatesDelete.js.map +1 -1
  38. package/funcs/templatesDirectLinkDelete.d.ts +1 -1
  39. package/funcs/templatesDirectLinkDelete.d.ts.map +1 -1
  40. package/funcs/templatesDirectLinkDelete.js +1 -2
  41. package/funcs/templatesDirectLinkDelete.js.map +1 -1
  42. package/funcs/templatesFieldsDelete.d.ts +1 -1
  43. package/funcs/templatesFieldsDelete.d.ts.map +1 -1
  44. package/funcs/templatesFieldsDelete.js +1 -2
  45. package/funcs/templatesFieldsDelete.js.map +1 -1
  46. package/funcs/templatesFieldsGet.d.ts +16 -0
  47. package/funcs/templatesFieldsGet.d.ts.map +1 -0
  48. package/funcs/{fieldsGet.js → templatesFieldsGet.js} +9 -9
  49. package/funcs/templatesFieldsGet.js.map +1 -0
  50. package/funcs/templatesRecipientsDelete.d.ts +1 -1
  51. package/funcs/templatesRecipientsDelete.d.ts.map +1 -1
  52. package/funcs/templatesRecipientsDelete.js +1 -2
  53. package/funcs/templatesRecipientsDelete.js.map +1 -1
  54. package/funcs/templatesRecipientsGet.d.ts +16 -0
  55. package/funcs/templatesRecipientsGet.d.ts.map +1 -0
  56. package/funcs/templatesRecipientsGet.js +116 -0
  57. package/funcs/templatesRecipientsGet.js.map +1 -0
  58. package/jsr.json +1 -1
  59. package/lib/config.d.ts +4 -4
  60. package/lib/config.d.ts.map +1 -1
  61. package/lib/config.js +4 -4
  62. package/lib/config.js.map +1 -1
  63. package/lib/schemas.d.ts +1 -1
  64. package/lib/schemas.d.ts.map +1 -1
  65. package/lib/schemas.js +4 -1
  66. package/lib/schemas.js.map +1 -1
  67. package/models/operations/documentdeletedocument.d.ts +28 -0
  68. package/models/operations/documentdeletedocument.d.ts.map +1 -1
  69. package/models/operations/documentdeletedocument.js +28 -1
  70. package/models/operations/documentdeletedocument.js.map +1 -1
  71. package/models/operations/documentresenddocument.d.ts +28 -0
  72. package/models/operations/documentresenddocument.d.ts.map +1 -1
  73. package/models/operations/documentresenddocument.js +28 -1
  74. package/models/operations/documentresenddocument.js.map +1 -1
  75. package/models/operations/fielddeletedocumentfield.d.ts +28 -0
  76. package/models/operations/fielddeletedocumentfield.d.ts.map +1 -1
  77. package/models/operations/fielddeletedocumentfield.js +28 -1
  78. package/models/operations/fielddeletedocumentfield.js.map +1 -1
  79. package/models/operations/fielddeletetemplatefield.d.ts +28 -0
  80. package/models/operations/fielddeletetemplatefield.d.ts.map +1 -1
  81. package/models/operations/fielddeletetemplatefield.js +28 -1
  82. package/models/operations/fielddeletetemplatefield.js.map +1 -1
  83. package/models/operations/{fieldgetfield.d.ts → fieldgetdocumentfield.d.ts} +142 -142
  84. package/models/operations/fieldgetdocumentfield.d.ts.map +1 -0
  85. package/models/operations/fieldgetdocumentfield.js +817 -0
  86. package/models/operations/fieldgetdocumentfield.js.map +1 -0
  87. package/models/operations/fieldgettemplatefield.d.ts +774 -0
  88. package/models/operations/fieldgettemplatefield.d.ts.map +1 -0
  89. package/models/operations/fieldgettemplatefield.js +819 -0
  90. package/models/operations/fieldgettemplatefield.js.map +1 -0
  91. package/models/operations/index.d.ts +4 -2
  92. package/models/operations/index.d.ts.map +1 -1
  93. package/models/operations/index.js +4 -2
  94. package/models/operations/index.js.map +1 -1
  95. package/models/operations/recipientdeletedocumentrecipient.d.ts +28 -0
  96. package/models/operations/recipientdeletedocumentrecipient.d.ts.map +1 -1
  97. package/models/operations/recipientdeletedocumentrecipient.js +28 -1
  98. package/models/operations/recipientdeletedocumentrecipient.js.map +1 -1
  99. package/models/operations/recipientdeletetemplaterecipient.d.ts +28 -0
  100. package/models/operations/recipientdeletetemplaterecipient.d.ts.map +1 -1
  101. package/models/operations/recipientdeletetemplaterecipient.js +28 -1
  102. package/models/operations/recipientdeletetemplaterecipient.js.map +1 -1
  103. package/models/operations/recipientgetdocumentrecipient.d.ts +1041 -0
  104. package/models/operations/recipientgetdocumentrecipient.d.ts.map +1 -0
  105. package/models/operations/recipientgetdocumentrecipient.js +1038 -0
  106. package/models/operations/recipientgetdocumentrecipient.js.map +1 -0
  107. package/models/operations/recipientgettemplaterecipient.d.ts +1041 -0
  108. package/models/operations/recipientgettemplaterecipient.d.ts.map +1 -0
  109. package/models/operations/recipientgettemplaterecipient.js +1039 -0
  110. package/models/operations/recipientgettemplaterecipient.js.map +1 -0
  111. package/models/operations/templatedeletetemplate.d.ts +28 -0
  112. package/models/operations/templatedeletetemplate.d.ts.map +1 -1
  113. package/models/operations/templatedeletetemplate.js +28 -1
  114. package/models/operations/templatedeletetemplate.js.map +1 -1
  115. package/models/operations/templatedeletetemplatedirectlink.d.ts +28 -0
  116. package/models/operations/templatedeletetemplatedirectlink.d.ts.map +1 -1
  117. package/models/operations/templatedeletetemplatedirectlink.js +28 -1
  118. package/models/operations/templatedeletetemplatedirectlink.js.map +1 -1
  119. package/package.json +5 -1
  120. package/sdk/directlink.d.ts +1 -1
  121. package/sdk/directlink.d.ts.map +1 -1
  122. package/sdk/documensofields.d.ts +21 -14
  123. package/sdk/documensofields.d.ts.map +1 -1
  124. package/sdk/documensofields.js +29 -19
  125. package/sdk/documensofields.js.map +1 -1
  126. package/sdk/documensorecipients.d.ts +21 -14
  127. package/sdk/documensorecipients.d.ts.map +1 -1
  128. package/sdk/documensorecipients.js +29 -19
  129. package/sdk/documensorecipients.js.map +1 -1
  130. package/sdk/documents.d.ts +6 -6
  131. package/sdk/documents.d.ts.map +1 -1
  132. package/sdk/documents.js +4 -4
  133. package/sdk/documents.js.map +1 -1
  134. package/sdk/fields.d.ts +35 -3
  135. package/sdk/fields.d.ts.map +1 -1
  136. package/sdk/fields.js +51 -4
  137. package/sdk/fields.js.map +1 -1
  138. package/sdk/recipients.d.ts +35 -3
  139. package/sdk/recipients.d.ts.map +1 -1
  140. package/sdk/recipients.js +51 -4
  141. package/sdk/recipients.js.map +1 -1
  142. package/sdk/sdk.d.ts +0 -6
  143. package/sdk/sdk.d.ts.map +1 -1
  144. package/sdk/sdk.js +0 -8
  145. package/sdk/sdk.js.map +1 -1
  146. package/sdk/templates.d.ts +5 -5
  147. package/sdk/templates.d.ts.map +1 -1
  148. package/sdk/templates.js +4 -4
  149. package/sdk/templates.js.map +1 -1
  150. package/src/funcs/documentsDelete.ts +3 -4
  151. package/src/funcs/documentsFieldsDelete.ts +3 -4
  152. package/src/funcs/{fieldsGet.ts → documentsFieldsGet.ts} +11 -10
  153. package/src/funcs/documentsRecipientsDelete.ts +6 -4
  154. package/src/funcs/{recipientsGet.ts → documentsRecipientsGet.ts} +15 -10
  155. package/src/funcs/documentsRedistribute.ts +3 -4
  156. package/src/funcs/templatesDelete.ts +3 -4
  157. package/src/funcs/templatesDirectLinkDelete.ts +6 -4
  158. package/src/funcs/templatesFieldsDelete.ts +3 -4
  159. package/src/funcs/templatesFieldsGet.ts +147 -0
  160. package/src/funcs/templatesRecipientsDelete.ts +6 -4
  161. package/src/funcs/templatesRecipientsGet.ts +152 -0
  162. package/src/lib/config.ts +4 -4
  163. package/src/lib/schemas.ts +5 -0
  164. package/src/models/operations/documentdeletedocument.ts +65 -0
  165. package/src/models/operations/documentresenddocument.ts +65 -0
  166. package/src/models/operations/fielddeletedocumentfield.ts +66 -0
  167. package/src/models/operations/fielddeletetemplatefield.ts +66 -0
  168. package/src/models/operations/{fieldgetfield.ts → fieldgetdocumentfield.ts} +337 -282
  169. package/src/models/operations/fieldgettemplatefield.ts +1697 -0
  170. package/src/models/operations/index.ts +4 -2
  171. package/src/models/operations/recipientdeletedocumentrecipient.ts +74 -0
  172. package/src/models/operations/recipientdeletetemplaterecipient.ts +74 -0
  173. package/src/models/operations/recipientgetdocumentrecipient.ts +2235 -0
  174. package/src/models/operations/recipientgettemplaterecipient.ts +2251 -0
  175. package/src/models/operations/templatedeletetemplate.ts +65 -0
  176. package/src/models/operations/templatedeletetemplatedirectlink.ts +74 -0
  177. package/src/sdk/directlink.ts +1 -1
  178. package/src/sdk/documensofields.ts +47 -29
  179. package/src/sdk/documensorecipients.ts +47 -29
  180. package/src/sdk/documents.ts +10 -10
  181. package/src/sdk/fields.ts +93 -6
  182. package/src/sdk/recipients.ts +93 -6
  183. package/src/sdk/sdk.ts +0 -12
  184. package/src/sdk/templates.ts +9 -11
  185. package/.devcontainer/README.md +0 -30
  186. package/.devcontainer/devcontainer.json +0 -45
  187. package/docs/sdks/documensotemplatesfields/README.md +0 -456
  188. package/docs/sdks/documensotemplatesrecipients/README.md +0 -440
  189. package/funcs/fieldsGet.d.ts.map +0 -1
  190. package/funcs/fieldsGet.js.map +0 -1
  191. package/funcs/recipientsGet.d.ts.map +0 -1
  192. package/funcs/recipientsGet.js.map +0 -1
  193. package/local-openapi.json +0 -21024
  194. package/models/operations/fieldgetfield.d.ts.map +0 -1
  195. package/models/operations/fieldgetfield.js +0 -820
  196. package/models/operations/fieldgetfield.js.map +0 -1
  197. package/models/operations/recipientgetrecipient.d.ts +0 -1041
  198. package/models/operations/recipientgetrecipient.d.ts.map +0 -1
  199. package/models/operations/recipientgetrecipient.js +0 -1033
  200. package/models/operations/recipientgetrecipient.js.map +0 -1
  201. package/sdk/documensotemplatesfields.d.ts +0 -37
  202. package/sdk/documensotemplatesfields.d.ts.map +0 -1
  203. package/sdk/documensotemplatesfields.js +0 -59
  204. package/sdk/documensotemplatesfields.js.map +0 -1
  205. package/sdk/documensotemplatesrecipients.d.ts +0 -37
  206. package/sdk/documensotemplatesrecipients.d.ts.map +0 -1
  207. package/sdk/documensotemplatesrecipients.js +0 -59
  208. package/sdk/documensotemplatesrecipients.js.map +0 -1
  209. package/src/models/operations/recipientgetrecipient.ts +0 -2060
  210. package/src/sdk/documensotemplatesfields.ts +0 -96
  211. package/src/sdk/documensotemplatesrecipients.ts +0 -96
@@ -1,440 +0,0 @@
1
- # DocumensoTemplatesRecipients
2
- (*templates.recipients*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [create](#create) - Create template recipient
9
- * [createMany](#createmany) - Create template recipients
10
- * [update](#update) - Update template recipient
11
- * [updateMany](#updatemany) - Update template recipients
12
- * [delete](#delete) - Delete template recipient
13
-
14
- ## create
15
-
16
- Create a single recipient for a template.
17
-
18
- ### Example Usage
19
-
20
- ```typescript
21
- import { Documenso } from "@documenso/sdk-typescript";
22
-
23
- const documenso = new Documenso({
24
- apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
25
- });
26
-
27
- async function run() {
28
- const result = await documenso.templates.recipients.create({
29
- templateId: 3169.32,
30
- recipient: {
31
- email: "Jorge.Kirlin@hotmail.com",
32
- name: "<value>",
33
- role: "SIGNER",
34
- },
35
- });
36
-
37
- // Handle the result
38
- console.log(result);
39
- }
40
-
41
- run();
42
- ```
43
-
44
- ### Standalone function
45
-
46
- The standalone function version of this method:
47
-
48
- ```typescript
49
- import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
50
- import { templatesRecipientsCreate } from "@documenso/sdk-typescript/funcs/templatesRecipientsCreate.js";
51
-
52
- // Use `DocumensoCore` for best tree-shaking performance.
53
- // You can create one instance of it to use across an application.
54
- const documenso = new DocumensoCore({
55
- apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
56
- });
57
-
58
- async function run() {
59
- const res = await templatesRecipientsCreate(documenso, {
60
- templateId: 3169.32,
61
- recipient: {
62
- email: "Jorge.Kirlin@hotmail.com",
63
- name: "<value>",
64
- role: "SIGNER",
65
- },
66
- });
67
-
68
- if (!res.ok) {
69
- throw res.error;
70
- }
71
-
72
- const { value: result } = res;
73
-
74
- // Handle the result
75
- console.log(result);
76
- }
77
-
78
- run();
79
- ```
80
-
81
- ### Parameters
82
-
83
- | Parameter | Type | Required | Description |
84
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
85
- | `request` | [operations.RecipientCreateTemplateRecipientRequestBody](../../models/operations/recipientcreatetemplaterecipientrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
86
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
87
- | `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
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
89
-
90
- ### Response
91
-
92
- **Promise\<[operations.RecipientCreateTemplateRecipientResponseBody](../../models/operations/recipientcreatetemplaterecipientresponsebody.md)\>**
93
-
94
- ### Errors
95
-
96
- | Error Type | Status Code | Content Type |
97
- | ------------------------------- | ------------------------------- | ------------------------------- |
98
- | errors.ErrorBADREQUEST | 400 | application/json |
99
- | errors.Errorinternalservererror | 500 | application/json |
100
- | errors.APIError | 4XX, 5XX | \*/\* |
101
-
102
- ## createMany
103
-
104
- Create multiple recipients for a template.
105
-
106
- ### Example Usage
107
-
108
- ```typescript
109
- import { Documenso } from "@documenso/sdk-typescript";
110
-
111
- const documenso = new Documenso({
112
- apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
113
- });
114
-
115
- async function run() {
116
- const result = await documenso.templates.recipients.createMany({
117
- templateId: 6206.07,
118
- recipients: [
119
-
120
- ],
121
- });
122
-
123
- // Handle the result
124
- console.log(result);
125
- }
126
-
127
- run();
128
- ```
129
-
130
- ### Standalone function
131
-
132
- The standalone function version of this method:
133
-
134
- ```typescript
135
- import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
136
- import { templatesRecipientsCreateMany } from "@documenso/sdk-typescript/funcs/templatesRecipientsCreateMany.js";
137
-
138
- // Use `DocumensoCore` for best tree-shaking performance.
139
- // You can create one instance of it to use across an application.
140
- const documenso = new DocumensoCore({
141
- apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
142
- });
143
-
144
- async function run() {
145
- const res = await templatesRecipientsCreateMany(documenso, {
146
- templateId: 6206.07,
147
- recipients: [
148
-
149
- ],
150
- });
151
-
152
- if (!res.ok) {
153
- throw res.error;
154
- }
155
-
156
- const { value: result } = res;
157
-
158
- // Handle the result
159
- console.log(result);
160
- }
161
-
162
- run();
163
- ```
164
-
165
- ### Parameters
166
-
167
- | Parameter | Type | Required | Description |
168
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
169
- | `request` | [operations.RecipientCreateTemplateRecipientsRequestBody](../../models/operations/recipientcreatetemplaterecipientsrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
170
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
171
- | `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
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
173
-
174
- ### Response
175
-
176
- **Promise\<[operations.RecipientCreateTemplateRecipientsResponseBody](../../models/operations/recipientcreatetemplaterecipientsresponsebody.md)\>**
177
-
178
- ### Errors
179
-
180
- | Error Type | Status Code | Content Type |
181
- | ------------------------------- | ------------------------------- | ------------------------------- |
182
- | errors.ErrorBADREQUEST | 400 | application/json |
183
- | errors.Errorinternalservererror | 500 | application/json |
184
- | errors.APIError | 4XX, 5XX | \*/\* |
185
-
186
- ## update
187
-
188
- Update a single recipient for a template.
189
-
190
- ### Example Usage
191
-
192
- ```typescript
193
- import { Documenso } from "@documenso/sdk-typescript";
194
-
195
- const documenso = new Documenso({
196
- apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
197
- });
198
-
199
- async function run() {
200
- const result = await documenso.templates.recipients.update({
201
- templateId: 4456.02,
202
- recipient: {
203
- id: 9017.65,
204
- },
205
- });
206
-
207
- // Handle the result
208
- console.log(result);
209
- }
210
-
211
- run();
212
- ```
213
-
214
- ### Standalone function
215
-
216
- The standalone function version of this method:
217
-
218
- ```typescript
219
- import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
220
- import { templatesRecipientsUpdate } from "@documenso/sdk-typescript/funcs/templatesRecipientsUpdate.js";
221
-
222
- // Use `DocumensoCore` for best tree-shaking performance.
223
- // You can create one instance of it to use across an application.
224
- const documenso = new DocumensoCore({
225
- apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
226
- });
227
-
228
- async function run() {
229
- const res = await templatesRecipientsUpdate(documenso, {
230
- templateId: 4456.02,
231
- recipient: {
232
- id: 9017.65,
233
- },
234
- });
235
-
236
- if (!res.ok) {
237
- throw res.error;
238
- }
239
-
240
- const { value: result } = res;
241
-
242
- // Handle the result
243
- console.log(result);
244
- }
245
-
246
- run();
247
- ```
248
-
249
- ### Parameters
250
-
251
- | Parameter | Type | Required | Description |
252
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
253
- | `request` | [operations.RecipientUpdateTemplateRecipientRequestBody](../../models/operations/recipientupdatetemplaterecipientrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
254
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
255
- | `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
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
257
-
258
- ### Response
259
-
260
- **Promise\<[operations.RecipientUpdateTemplateRecipientResponseBody](../../models/operations/recipientupdatetemplaterecipientresponsebody.md)\>**
261
-
262
- ### Errors
263
-
264
- | Error Type | Status Code | Content Type |
265
- | ------------------------------- | ------------------------------- | ------------------------------- |
266
- | errors.ErrorBADREQUEST | 400 | application/json |
267
- | errors.Errorinternalservererror | 500 | application/json |
268
- | errors.APIError | 4XX, 5XX | \*/\* |
269
-
270
- ## updateMany
271
-
272
- Update multiple recipients for a template.
273
-
274
- ### Example Usage
275
-
276
- ```typescript
277
- import { Documenso } from "@documenso/sdk-typescript";
278
-
279
- const documenso = new Documenso({
280
- apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
281
- });
282
-
283
- async function run() {
284
- const result = await documenso.templates.recipients.updateMany({
285
- templateId: 2320.69,
286
- recipients: [
287
- {
288
- id: 8980.22,
289
- },
290
- {
291
- id: 7442.40,
292
- },
293
- ],
294
- });
295
-
296
- // Handle the result
297
- console.log(result);
298
- }
299
-
300
- run();
301
- ```
302
-
303
- ### Standalone function
304
-
305
- The standalone function version of this method:
306
-
307
- ```typescript
308
- import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
309
- import { templatesRecipientsUpdateMany } from "@documenso/sdk-typescript/funcs/templatesRecipientsUpdateMany.js";
310
-
311
- // Use `DocumensoCore` for best tree-shaking performance.
312
- // You can create one instance of it to use across an application.
313
- const documenso = new DocumensoCore({
314
- apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
315
- });
316
-
317
- async function run() {
318
- const res = await templatesRecipientsUpdateMany(documenso, {
319
- templateId: 2320.69,
320
- recipients: [
321
- {
322
- id: 8980.22,
323
- },
324
- {
325
- id: 7442.40,
326
- },
327
- ],
328
- });
329
-
330
- if (!res.ok) {
331
- throw res.error;
332
- }
333
-
334
- const { value: result } = res;
335
-
336
- // Handle the result
337
- console.log(result);
338
- }
339
-
340
- run();
341
- ```
342
-
343
- ### Parameters
344
-
345
- | Parameter | Type | Required | Description |
346
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
347
- | `request` | [operations.RecipientUpdateTemplateRecipientsRequestBody](../../models/operations/recipientupdatetemplaterecipientsrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
348
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
349
- | `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. |
350
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
351
-
352
- ### Response
353
-
354
- **Promise\<[operations.RecipientUpdateTemplateRecipientsResponseBody](../../models/operations/recipientupdatetemplaterecipientsresponsebody.md)\>**
355
-
356
- ### Errors
357
-
358
- | Error Type | Status Code | Content Type |
359
- | ------------------------------- | ------------------------------- | ------------------------------- |
360
- | errors.ErrorBADREQUEST | 400 | application/json |
361
- | errors.Errorinternalservererror | 500 | application/json |
362
- | errors.APIError | 4XX, 5XX | \*/\* |
363
-
364
- ## delete
365
-
366
- Delete template recipient
367
-
368
- ### Example Usage
369
-
370
- ```typescript
371
- import { Documenso } from "@documenso/sdk-typescript";
372
-
373
- const documenso = new Documenso({
374
- apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
375
- });
376
-
377
- async function run() {
378
- const result = await documenso.templates.recipients.delete({
379
- recipientId: 6857.35,
380
- });
381
-
382
- // Handle the result
383
- console.log(result);
384
- }
385
-
386
- run();
387
- ```
388
-
389
- ### Standalone function
390
-
391
- The standalone function version of this method:
392
-
393
- ```typescript
394
- import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
395
- import { templatesRecipientsDelete } from "@documenso/sdk-typescript/funcs/templatesRecipientsDelete.js";
396
-
397
- // Use `DocumensoCore` for best tree-shaking performance.
398
- // You can create one instance of it to use across an application.
399
- const documenso = new DocumensoCore({
400
- apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
401
- });
402
-
403
- async function run() {
404
- const res = await templatesRecipientsDelete(documenso, {
405
- recipientId: 6857.35,
406
- });
407
-
408
- if (!res.ok) {
409
- throw res.error;
410
- }
411
-
412
- const { value: result } = res;
413
-
414
- // Handle the result
415
- console.log(result);
416
- }
417
-
418
- run();
419
- ```
420
-
421
- ### Parameters
422
-
423
- | Parameter | Type | Required | Description |
424
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
425
- | `request` | [operations.RecipientDeleteTemplateRecipientRequestBody](../../models/operations/recipientdeletetemplaterecipientrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
426
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
427
- | `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. |
428
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
429
-
430
- ### Response
431
-
432
- **Promise\<[any](../../models/.md)\>**
433
-
434
- ### Errors
435
-
436
- | Error Type | Status Code | Content Type |
437
- | ------------------------------- | ------------------------------- | ------------------------------- |
438
- | errors.ErrorBADREQUEST | 400 | application/json |
439
- | errors.Errorinternalservererror | 500 | application/json |
440
- | errors.APIError | 4XX, 5XX | \*/\* |
@@ -1 +0,0 @@
1
- {"version":3,"file":"fieldsGet.d.ts","sourceRoot":"","sources":["../src/funcs/fieldsGet.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAK3C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAsB,SAAS,CAC7B,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,MAAM,CACJ,UAAU,CAAC,yBAAyB,EAClC,MAAM,CAAC,eAAe,GACtB,MAAM,CAAC,aAAa,GACpB,MAAM,CAAC,wBAAwB,GAC/B,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAgGA"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"fieldsGet.js","sourceRoot":"","sources":["../src/funcs/fieldsGet.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BH,8BAkHC;AA5ID,sDAAmD;AACnD,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAS3C,kEAAoD;AAEpD,0EAA4D;AAG5D;;;;;GAKG;AACI,KAAK,UAAU,SAAS,CAC7B,MAAqB,EACrB,OAAwC,EACxC,OAAwB;IAgBxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,mCAAmC,CAAC,KAAK,CAAC,KAAK,CAAC,EACtE,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAI,CAAC;IAElB,MAAM,UAAU,GAAG;QACjB,OAAO,EAAE,IAAA,2BAAY,EAAC,SAAS,EAAE,OAAO,CAAC,OAAO,EAAE;YAChD,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;KACH,CAAC;IAEF,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,kBAAkB,CAAC,CAAC,UAAU,CAAC,CAAC;IAExD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAChE,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IACrE,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,WAAW,EAAE,gBAAgB;QAC7B,YAAY,EAAE,EAAE;QAEhB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM;QACtC,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QAC/C,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAa5B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,uCAAuC,CAAC,EAC/D,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,6BAA6B,CAAC,EACpD,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,2BAA2B,CAAC,EAClD,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,sCAAsC,CAAC,EAC7D,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAC7C,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"recipientsGet.d.ts","sourceRoot":"","sources":["../src/funcs/recipientsGet.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAK3C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAsB,aAAa,CACjC,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,UAAU,CAAC,4BAA4B,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,MAAM,CACJ,UAAU,CAAC,iCAAiC,EAC1C,MAAM,CAAC,eAAe,GACtB,MAAM,CAAC,aAAa,GACpB,MAAM,CAAC,wBAAwB,GAC/B,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAiGA"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"recipientsGet.js","sourceRoot":"","sources":["../src/funcs/recipientsGet.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BH,sCAmHC;AA7ID,sDAAmD;AACnD,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAS3C,kEAAoD;AAEpD,0EAA4D;AAG5D;;;;;GAKG;AACI,KAAK,UAAU,aAAa,CACjC,MAAqB,EACrB,OAAgD,EAChD,OAAwB;IAgBxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CACR,UAAU,CAAC,2CAA2C,CAAC,KAAK,CAAC,KAAK,CAAC,EACrE,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAI,CAAC;IAElB,MAAM,UAAU,GAAG;QACjB,WAAW,EAAE,IAAA,2BAAY,EAAC,aAAa,EAAE,OAAO,CAAC,WAAW,EAAE;YAC5D,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;KACH,CAAC;IAEF,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,0BAA0B,CAAC,CAAC,UAAU,CAAC,CAAC;IAEhE,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAChE,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IACrE,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,WAAW,EAAE,wBAAwB;QACrC,YAAY,EAAE,EAAE;QAEhB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM;QACtC,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QAC/C,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAa5B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,+CAA+C,CAAC,EACvE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,6BAA6B,CAAC,EACpD,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,2BAA2B,CAAC,EAClD,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,sCAAsC,CAAC,EAC7D,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAC7C,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}