boldsign 3.0.0 → 3.0.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 (196) hide show
  1. package/.openapi-generator/FILES +8 -0
  2. package/LICENSE +1 -1
  3. package/README.md +11 -0
  4. package/api/apis.ts +1 -1
  5. package/api/documentApi.ts +111 -0
  6. package/api/templateApi.ts +128 -2
  7. package/api/userApi.ts +122 -1
  8. package/boldsign-3.0.2.tgz +0 -0
  9. package/dist/api/apis.d.ts +1 -1
  10. package/dist/api/apis.js +1 -1
  11. package/dist/api/documentApi.d.ts +1 -0
  12. package/dist/api/documentApi.js +75 -0
  13. package/dist/api/documentApi.js.map +1 -1
  14. package/dist/api/templateApi.d.ts +3 -2
  15. package/dist/api/templateApi.js +86 -2
  16. package/dist/api/templateApi.js.map +1 -1
  17. package/dist/api/userApi.d.ts +2 -1
  18. package/dist/api/userApi.js +81 -0
  19. package/dist/api/userApi.js.map +1 -1
  20. package/dist/examples/draftSend.d.ts +1 -0
  21. package/dist/examples/draftSend.js +27 -0
  22. package/dist/examples/draftSend.js.map +1 -0
  23. package/dist/examples/embeddedCreatePreviewUrl.d.ts +1 -0
  24. package/dist/examples/embeddedCreatePreviewUrl.js +29 -0
  25. package/dist/examples/embeddedCreatePreviewUrl.js.map +1 -0
  26. package/dist/examples/userChangeTeam.d.ts +1 -0
  27. package/dist/examples/userChangeTeam.js +30 -0
  28. package/dist/examples/userChangeTeam.js.map +1 -0
  29. package/dist/model/attachmentInfo.d.ts +2 -2
  30. package/dist/model/attachmentInfo.js +6 -6
  31. package/dist/model/attachmentInfo.js.map +1 -1
  32. package/dist/model/changeTeamRequest.d.ts +15 -0
  33. package/dist/model/changeTeamRequest.js +23 -0
  34. package/dist/model/changeTeamRequest.js.map +1 -0
  35. package/dist/model/createSenderIdentityRequest.d.ts +26 -0
  36. package/dist/model/createSenderIdentityRequest.js +31 -0
  37. package/dist/model/createSenderIdentityRequest.js.map +1 -1
  38. package/dist/model/createTemplateRequest.d.ts +2 -0
  39. package/dist/model/createTemplateRequest.js +5 -0
  40. package/dist/model/createTemplateRequest.js.map +1 -1
  41. package/dist/model/documentInfo.d.ts +4 -2
  42. package/dist/model/documentInfo.js +2 -0
  43. package/dist/model/documentInfo.js.map +1 -1
  44. package/dist/model/documentProperties.d.ts +2 -0
  45. package/dist/model/documentProperties.js +5 -0
  46. package/dist/model/documentProperties.js.map +1 -1
  47. package/dist/model/documentSigner.d.ts +11 -3
  48. package/dist/model/documentSigner.js +21 -4
  49. package/dist/model/documentSigner.js.map +1 -1
  50. package/dist/model/documentSignerDetails.d.ts +12 -2
  51. package/dist/model/documentSignerDetails.js +23 -0
  52. package/dist/model/documentSignerDetails.js.map +1 -1
  53. package/dist/model/editSenderIdentityRequest.d.ts +26 -0
  54. package/dist/model/editSenderIdentityRequest.js +31 -0
  55. package/dist/model/editSenderIdentityRequest.js.map +1 -1
  56. package/dist/model/editTemplateRequest.d.ts +2 -0
  57. package/dist/model/editTemplateRequest.js +5 -0
  58. package/dist/model/editTemplateRequest.js.map +1 -1
  59. package/dist/model/embeddedCreateTemplateRequest.d.ts +4 -1
  60. package/dist/model/embeddedCreateTemplateRequest.js +6 -0
  61. package/dist/model/embeddedCreateTemplateRequest.js.map +1 -1
  62. package/dist/model/embeddedDocumentRequest.d.ts +4 -1
  63. package/dist/model/embeddedDocumentRequest.js +6 -0
  64. package/dist/model/embeddedDocumentRequest.js.map +1 -1
  65. package/dist/model/embeddedMergeTemplateFormRequest.d.ts +4 -1
  66. package/dist/model/embeddedMergeTemplateFormRequest.js +6 -0
  67. package/dist/model/embeddedMergeTemplateFormRequest.js.map +1 -1
  68. package/dist/model/embeddedSendTemplateFormRequest.d.ts +4 -1
  69. package/dist/model/embeddedSendTemplateFormRequest.js +6 -0
  70. package/dist/model/embeddedSendTemplateFormRequest.js.map +1 -1
  71. package/dist/model/embeddedTemplateEditRequest.d.ts +2 -1
  72. package/dist/model/embeddedTemplateEditRequest.js +1 -0
  73. package/dist/model/embeddedTemplateEditRequest.js.map +1 -1
  74. package/dist/model/embeddedTemplatePreview.d.ts +14 -0
  75. package/dist/model/embeddedTemplatePreview.js +18 -0
  76. package/dist/model/embeddedTemplatePreview.js.map +1 -0
  77. package/dist/model/embeddedTemplatePreviewJsonRequest.d.ts +15 -0
  78. package/dist/model/embeddedTemplatePreviewJsonRequest.js +23 -0
  79. package/dist/model/embeddedTemplatePreviewJsonRequest.js.map +1 -0
  80. package/dist/model/font.d.ts +2 -2
  81. package/dist/model/groupSigner.d.ts +30 -0
  82. package/dist/model/groupSigner.js +59 -0
  83. package/dist/model/groupSigner.js.map +1 -0
  84. package/dist/model/groupSignerSettings.d.ts +15 -0
  85. package/dist/model/groupSignerSettings.js +23 -0
  86. package/dist/model/groupSignerSettings.js.map +1 -0
  87. package/dist/model/index.d.ts +9 -1
  88. package/dist/model/index.js +37 -3
  89. package/dist/model/index.js.map +1 -1
  90. package/dist/model/mergeAndSendForSignForm.d.ts +2 -0
  91. package/dist/model/mergeAndSendForSignForm.js +5 -0
  92. package/dist/model/mergeAndSendForSignForm.js.map +1 -1
  93. package/dist/model/role.d.ts +10 -2
  94. package/dist/model/role.js +17 -0
  95. package/dist/model/role.js.map +1 -1
  96. package/dist/model/roles.d.ts +12 -2
  97. package/dist/model/roles.js +22 -0
  98. package/dist/model/roles.js.map +1 -1
  99. package/dist/model/sendForSign.d.ts +2 -0
  100. package/dist/model/sendForSign.js +5 -0
  101. package/dist/model/sendForSign.js.map +1 -1
  102. package/dist/model/sendForSignFromTemplateForm.d.ts +2 -0
  103. package/dist/model/sendForSignFromTemplateForm.js +5 -0
  104. package/dist/model/sendForSignFromTemplateForm.js.map +1 -1
  105. package/dist/model/senderIdentityViewModel.d.ts +1 -0
  106. package/dist/model/senderIdentityViewModel.js +5 -0
  107. package/dist/model/senderIdentityViewModel.js.map +1 -1
  108. package/dist/model/templateGroupSigner.d.ts +15 -0
  109. package/dist/model/templateGroupSigner.js +23 -0
  110. package/dist/model/templateGroupSigner.js.map +1 -0
  111. package/dist/model/templateProperties.d.ts +4 -0
  112. package/dist/model/templateProperties.js +10 -0
  113. package/dist/model/templateProperties.js.map +1 -1
  114. package/dist/model/templateRole.d.ts +10 -2
  115. package/dist/model/templateRole.js +17 -0
  116. package/dist/model/templateRole.js.map +1 -1
  117. package/dist/model/templateSharing.d.ts +15 -0
  118. package/dist/model/templateSharing.js +18 -0
  119. package/dist/model/templateSharing.js.map +1 -0
  120. package/dist/model/templateSignerDetails.d.ts +3 -0
  121. package/dist/model/templateSignerDetails.js +10 -0
  122. package/dist/model/templateSignerDetails.js.map +1 -1
  123. package/dist/model/templateTeamShare.d.ts +22 -0
  124. package/dist/model/templateTeamShare.js +31 -0
  125. package/dist/model/templateTeamShare.js.map +1 -0
  126. package/docs/AttachmentInfo.md +2 -2
  127. package/docs/ChangeTeamRequest.md +12 -0
  128. package/docs/CreateSenderIdentityRequest.md +1 -0
  129. package/docs/CreateTemplateRequest.md +1 -0
  130. package/docs/DocumentApi.md +33 -0
  131. package/docs/DocumentInfo.md +1 -1
  132. package/docs/DocumentProperties.md +1 -0
  133. package/docs/DocumentSigner.md +4 -2
  134. package/docs/DocumentSignerDetails.md +4 -1
  135. package/docs/EditSenderIdentityRequest.md +1 -0
  136. package/docs/EditTemplateRequest.md +1 -0
  137. package/docs/EmbeddedCreateTemplateRequest.md +1 -0
  138. package/docs/EmbeddedDocumentRequest.md +1 -0
  139. package/docs/EmbeddedMergeTemplateFormRequest.md +1 -0
  140. package/docs/EmbeddedSendTemplateFormRequest.md +1 -0
  141. package/docs/EmbeddedTemplatePreview.md +11 -0
  142. package/docs/EmbeddedTemplatePreviewJsonRequest.md +12 -0
  143. package/docs/GroupSigner.md +17 -0
  144. package/docs/GroupSignerSettings.md +12 -0
  145. package/docs/MergeAndSendForSignForm.md +1 -0
  146. package/docs/Role.md +3 -1
  147. package/docs/Roles.md +4 -1
  148. package/docs/SendForSign.md +1 -0
  149. package/docs/SendForSignFromTemplateForm.md +1 -0
  150. package/docs/SenderIdentityViewModel.md +1 -0
  151. package/docs/TemplateApi.md +36 -1
  152. package/docs/TemplateGroupSigner.md +12 -0
  153. package/docs/TemplateProperties.md +2 -0
  154. package/docs/TemplateRole.md +3 -1
  155. package/docs/TemplateSharing.md +11 -0
  156. package/docs/TemplateSignerDetails.md +2 -0
  157. package/docs/TemplateTeamShare.md +12 -0
  158. package/docs/UserApi.md +34 -0
  159. package/examples/draftSend.ts +12 -0
  160. package/examples/embeddedCreatePreviewUrl.ts +15 -0
  161. package/examples/userChangeTeam.ts +15 -0
  162. package/model/attachmentInfo.ts +8 -8
  163. package/model/changeTeamRequest.ts +37 -0
  164. package/model/createSenderIdentityRequest.ts +31 -0
  165. package/model/createTemplateRequest.ts +7 -0
  166. package/model/documentInfo.ts +5 -3
  167. package/model/documentProperties.ts +7 -0
  168. package/model/documentSigner.ts +26 -8
  169. package/model/documentSignerDetails.ts +28 -3
  170. package/model/editSenderIdentityRequest.ts +31 -0
  171. package/model/editTemplateRequest.ts +7 -0
  172. package/model/embeddedCreateTemplateRequest.ts +9 -1
  173. package/model/embeddedDocumentRequest.ts +9 -1
  174. package/model/embeddedMergeTemplateFormRequest.ts +9 -1
  175. package/model/embeddedSendTemplateFormRequest.ts +9 -1
  176. package/model/embeddedTemplateEditRequest.ts +2 -1
  177. package/model/embeddedTemplatePreview.ts +31 -0
  178. package/model/embeddedTemplatePreviewJsonRequest.ts +37 -0
  179. package/model/font.ts +2 -2
  180. package/model/groupSigner.ts +77 -0
  181. package/model/groupSignerSettings.ts +37 -0
  182. package/model/index.ts +33 -0
  183. package/model/mergeAndSendForSignForm.ts +7 -0
  184. package/model/role.ts +21 -3
  185. package/model/roles.ts +28 -3
  186. package/model/sendForSign.ts +7 -0
  187. package/model/sendForSignFromTemplateForm.ts +7 -0
  188. package/model/senderIdentityViewModel.ts +6 -0
  189. package/model/templateGroupSigner.ts +37 -0
  190. package/model/templateProperties.ts +14 -0
  191. package/model/templateRole.ts +21 -3
  192. package/model/templateSharing.ts +32 -0
  193. package/model/templateSignerDetails.ts +13 -0
  194. package/model/templateTeamShare.ts +44 -0
  195. package/package.json +1 -1
  196. package/boldsign-3.0.0.tgz +0 -0
@@ -32,6 +32,7 @@ model/brandCustomFieldDetails.ts
32
32
  model/brandingMessage.ts
33
33
  model/brandingRecords.ts
34
34
  model/changeRecipient.ts
35
+ model/changeTeamRequest.ts
35
36
  model/collaborationSettings.ts
36
37
  model/conditionalRule.ts
37
38
  model/contactCreated.ts
@@ -80,6 +81,8 @@ model/embeddedSigningLink.ts
80
81
  model/embeddedTemplateCreated.ts
81
82
  model/embeddedTemplateEditRequest.ts
82
83
  model/embeddedTemplateEdited.ts
84
+ model/embeddedTemplatePreview.ts
85
+ model/embeddedTemplatePreviewJsonRequest.ts
83
86
  model/errorResult.ts
84
87
  model/existingFormField.ts
85
88
  model/extendExpiry.ts
@@ -89,6 +92,8 @@ model/formField.ts
89
92
  model/formFieldPermission.ts
90
93
  model/formGroup.ts
91
94
  model/formulaFieldSettings.ts
95
+ model/groupSigner.ts
96
+ model/groupSignerSettings.ts
92
97
  model/idDocument.ts
93
98
  model/idReport.ts
94
99
  model/idVerification.ts
@@ -136,14 +141,17 @@ model/templateCC.ts
136
141
  model/templateCreated.ts
137
142
  model/templateFiles.ts
138
143
  model/templateFormFields.ts
144
+ model/templateGroupSigner.ts
139
145
  model/templateProperties.ts
140
146
  model/templateRecords.ts
141
147
  model/templateRole.ts
142
148
  model/templateSenderDetail.ts
143
149
  model/templateSenderDetails.ts
144
150
  model/templateSharedTemplateDetail.ts
151
+ model/templateSharing.ts
145
152
  model/templateSignerDetails.ts
146
153
  model/templateTag.ts
154
+ model/templateTeamShare.ts
147
155
  model/textTagDefinition.ts
148
156
  model/textTagOffset.ts
149
157
  model/updateUser.ts
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  The MIT License (MIT)
2
2
 
3
- Copyright (c) 2025 BoldSign by Syncfusion Inc.
3
+ Copyright (c) 2026 BoldSign by Syncfusion Inc.
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the “Software”), to deal
package/README.md CHANGED
@@ -93,6 +93,7 @@ All URIs are relative to *https://api.boldsign.com*
93
93
  | *DocumentApi* | [**downloadAttachment**](./docs/DocumentApi.md#downloadattachment) | **GET** /v1/document/downloadAttachment | Download the Attachment. |
94
94
  | *DocumentApi* | [**downloadAuditLog**](./docs/DocumentApi.md#downloadauditlog) | **GET** /v1/document/downloadAuditLog | Download the audit trail document. |
95
95
  | *DocumentApi* | [**downloadDocument**](./docs/DocumentApi.md#downloaddocument) | **GET** /v1/document/download | Download the document. |
96
+ | *DocumentApi* | [**draftSend**](./docs/DocumentApi.md#draftsend) | **POST** /v1/document/draftSend | Sends a draft-status document out for signature. |
96
97
  | *DocumentApi* | [**extendExpiry**](./docs/DocumentApi.md#extendexpiry) | **PATCH** /v1/document/extendExpiry | Extends the expiration date of the document. |
97
98
  | *DocumentApi* | [**getProperties**](./docs/DocumentApi.md#getproperties) | **GET** /v1/document/properties | Get summary of the document. |
98
99
  | *DocumentApi* | [**getEmbeddedSignLink**](./docs/DocumentApi.md#getembeddedsignlink) | **GET** /v1/document/getEmbeddedSignLink | Get sign link for Embedded Sign. |
@@ -119,6 +120,7 @@ All URIs are relative to *https://api.boldsign.com*
119
120
  | *TeamsApi* | [**listTeams**](./docs/TeamsApi.md#listteams) | **GET** /v1/teams/list | List Teams. |
120
121
  | *TeamsApi* | [**updateTeam**](./docs/TeamsApi.md#updateteam) | **PUT** /v1/teams/update | Update Team. |
121
122
  | *TemplateApi* | [**addTag**](./docs/TemplateApi.md#addtag) | **PATCH** /v1/template/addTags | Add the Tags in Templates. |
123
+ | *TemplateApi* | [**createEmbeddedPreviewUrl**](./docs/TemplateApi.md#createembeddedpreviewurl) | **POST** /v1/template/createEmbeddedPreviewUrl | Generates a preview URL for a template to view it. |
122
124
  | *TemplateApi* | [**createEmbeddedRequestUrlTemplate**](./docs/TemplateApi.md#createembeddedrequesturltemplate) | **POST** /v1/template/createEmbeddedRequestUrl | Generates a send URL using a template which embeds document sending process into your application. |
123
125
  | *TemplateApi* | [**createEmbeddedTemplateUrl**](./docs/TemplateApi.md#createembeddedtemplateurl) | **POST** /v1/template/createEmbeddedTemplateUrl | Generates a create URL to embeds template create process into your application. |
124
126
  | *TemplateApi* | [**createTemplate**](./docs/TemplateApi.md#createtemplate) | **POST** /v1/template/create | Creates a new template. |
@@ -133,6 +135,7 @@ All URIs are relative to *https://api.boldsign.com*
133
135
  | *TemplateApi* | [**mergeCreateEmbeddedRequestUrlTemplate**](./docs/TemplateApi.md#mergecreateembeddedrequesturltemplate) | **POST** /v1/template/mergeCreateEmbeddedRequestUrl | Generates a merge request URL using a template that combines document merging and sending processes into your application. |
134
136
  | *TemplateApi* | [**sendUsingTemplate**](./docs/TemplateApi.md#sendusingtemplate) | **POST** /v1/template/send | Send a document for signature using a Template. |
135
137
  | *UserApi* | [**cancelInvitation**](./docs/UserApi.md#cancelinvitation) | **POST** /v1/users/cancelInvitation | Cancel the users invitation. |
138
+ | *UserApi* | [**changeTeam**](./docs/UserApi.md#changeteam) | **PUT** /v1/users/changeTeam | Change users to other team. |
136
139
  | *UserApi* | [**createUser**](./docs/UserApi.md#createuser) | **POST** /v1/users/create | Create the user. |
137
140
  | *UserApi* | [**getUser**](./docs/UserApi.md#getuser) | **GET** /v1/users/get | Get summary of the user. |
138
141
  | *UserApi* | [**listUsers**](./docs/UserApi.md#listusers) | **GET** /v1/users/list | List user documents. |
@@ -159,6 +162,7 @@ All URIs are relative to *https://api.boldsign.com*
159
162
  - [BrandingMessage](./docs/BrandingMessage.md)
160
163
  - [BrandingRecords](./docs/BrandingRecords.md)
161
164
  - [ChangeRecipient](./docs/ChangeRecipient.md)
165
+ - [ChangeTeamRequest](./docs/ChangeTeamRequest.md)
162
166
  - [CollaborationSettings](./docs/CollaborationSettings.md)
163
167
  - [ConditionalRule](./docs/ConditionalRule.md)
164
168
  - [ContactCreated](./docs/ContactCreated.md)
@@ -207,6 +211,8 @@ All URIs are relative to *https://api.boldsign.com*
207
211
  - [EmbeddedTemplateCreated](./docs/EmbeddedTemplateCreated.md)
208
212
  - [EmbeddedTemplateEditRequest](./docs/EmbeddedTemplateEditRequest.md)
209
213
  - [EmbeddedTemplateEdited](./docs/EmbeddedTemplateEdited.md)
214
+ - [EmbeddedTemplatePreview](./docs/EmbeddedTemplatePreview.md)
215
+ - [EmbeddedTemplatePreviewJsonRequest](./docs/EmbeddedTemplatePreviewJsonRequest.md)
210
216
  - [ErrorResult](./docs/ErrorResult.md)
211
217
  - [ExistingFormField](./docs/ExistingFormField.md)
212
218
  - [ExtendExpiry](./docs/ExtendExpiry.md)
@@ -216,6 +222,8 @@ All URIs are relative to *https://api.boldsign.com*
216
222
  - [FormFieldPermission](./docs/FormFieldPermission.md)
217
223
  - [FormGroup](./docs/FormGroup.md)
218
224
  - [FormulaFieldSettings](./docs/FormulaFieldSettings.md)
225
+ - [GroupSigner](./docs/GroupSigner.md)
226
+ - [GroupSignerSettings](./docs/GroupSignerSettings.md)
219
227
  - [IdDocument](./docs/IdDocument.md)
220
228
  - [IdReport](./docs/IdReport.md)
221
229
  - [IdVerification](./docs/IdVerification.md)
@@ -261,14 +269,17 @@ All URIs are relative to *https://api.boldsign.com*
261
269
  - [TemplateCreated](./docs/TemplateCreated.md)
262
270
  - [TemplateFiles](./docs/TemplateFiles.md)
263
271
  - [TemplateFormFields](./docs/TemplateFormFields.md)
272
+ - [TemplateGroupSigner](./docs/TemplateGroupSigner.md)
264
273
  - [TemplateProperties](./docs/TemplateProperties.md)
265
274
  - [TemplateRecords](./docs/TemplateRecords.md)
266
275
  - [TemplateRole](./docs/TemplateRole.md)
267
276
  - [TemplateSenderDetail](./docs/TemplateSenderDetail.md)
268
277
  - [TemplateSenderDetails](./docs/TemplateSenderDetails.md)
269
278
  - [TemplateSharedTemplateDetail](./docs/TemplateSharedTemplateDetail.md)
279
+ - [TemplateSharing](./docs/TemplateSharing.md)
270
280
  - [TemplateSignerDetails](./docs/TemplateSignerDetails.md)
271
281
  - [TemplateTag](./docs/TemplateTag.md)
282
+ - [TemplateTeamShare](./docs/TemplateTeamShare.md)
272
283
  - [TextTagDefinition](./docs/TextTagDefinition.md)
273
284
  - [TextTagOffset](./docs/TextTagOffset.md)
274
285
  - [UpdateUser](./docs/UpdateUser.md)
package/api/apis.ts CHANGED
@@ -24,7 +24,7 @@ export const queryParamsSerializer = (params) => {
24
24
  return Qs.stringify(params, { arrayFormat: 'repeat' })
25
25
  }
26
26
 
27
- export const USER_AGENT = "boldsign-node-sdk/3.0.0";
27
+ export const USER_AGENT = "boldsign-node-sdk/3.0.2";
28
28
 
29
29
  /**
30
30
  * Generates an object containing form data.
@@ -1498,6 +1498,117 @@ export class DocumentApi {
1498
1498
  }
1499
1499
 
1500
1500
 
1501
+ reject(error);
1502
+ });
1503
+ });
1504
+ });
1505
+ }
1506
+ /**
1507
+ *
1508
+ * @summary Sends a draft-status document out for signature.
1509
+ * @param documentId The ID of the document to be sent.
1510
+ * @param options
1511
+ */
1512
+ public async draftSend (documentId: string, options: optionsI = {headers: {}}) : Promise<returnTypeI> {
1513
+ const localVarPath = this.basePath + '/v1/document/draftSend';
1514
+ let localVarQueryParameters: any = {};
1515
+ let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
1516
+ const produces = ['application/json'];
1517
+ // give precedence to 'application/json'
1518
+ if (produces.indexOf('application/json') >= 0) {
1519
+ localVarHeaderParams['content-type'] = 'application/json';
1520
+ } else {
1521
+ localVarHeaderParams['content-type'] = produces.join(',');
1522
+ }
1523
+ let localVarFormParams: any = {};
1524
+ let localVarBodyParams: any = undefined;
1525
+
1526
+ // verify required parameter 'documentId' is not null or undefined
1527
+ if (documentId === null || documentId === undefined) {
1528
+ throw new Error('Required parameter documentId was null or undefined when calling draftSend.');
1529
+ }
1530
+
1531
+ if (documentId !== undefined) {
1532
+ localVarQueryParameters['documentId'] = ObjectSerializer.serialize(documentId, "string");
1533
+ }
1534
+
1535
+ (<any>Object).assign(localVarHeaderParams, options.headers);
1536
+
1537
+ let localVarUseFormData = false;
1538
+
1539
+ let data = {};
1540
+ if (localVarUseFormData) {
1541
+ const formData = toFormData(localVarFormParams);
1542
+ data = formData;
1543
+ localVarHeaderParams = {
1544
+ ...localVarHeaderParams,
1545
+ ...formData.getHeaders(),
1546
+ };
1547
+ }
1548
+
1549
+ let localVarRequestOptions: AxiosRequestConfig = {
1550
+ method: 'POST',
1551
+ params: localVarQueryParameters,
1552
+ headers: localVarHeaderParams,
1553
+ url: localVarPath,
1554
+ paramsSerializer: this._useQuerystring ? queryParamsSerializer : undefined,
1555
+ maxContentLength: Infinity,
1556
+ maxBodyLength: Infinity,
1557
+ responseType: "json",
1558
+ };
1559
+
1560
+ if (localVarRequestOptions.method !== 'GET') {
1561
+ localVarRequestOptions.data = data;
1562
+ }
1563
+ let authenticationPromise = Promise.resolve();
1564
+
1565
+ if (this.authentications["X-API-KEY"].apiKey) {
1566
+ authenticationPromise = authenticationPromise.then(() => this.authentications["X-API-KEY"].applyToRequest(localVarRequestOptions));
1567
+ }
1568
+ if (this.authentications["Bearer"].apiKey) {
1569
+ authenticationPromise = authenticationPromise.then(() => this.authentications["Bearer"].applyToRequest(localVarRequestOptions));
1570
+ }
1571
+ authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
1572
+
1573
+ let interceptorPromise = authenticationPromise;
1574
+ for (const interceptor of this.interceptors) {
1575
+ interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
1576
+ }
1577
+
1578
+ return interceptorPromise.then(() => {
1579
+ return new Promise<returnTypeI>((resolve, reject) => {
1580
+ axios.request(localVarRequestOptions)
1581
+ .then((response) => {
1582
+ handleSuccessfulResponse(
1583
+ resolve,
1584
+ reject,
1585
+ response,
1586
+
1587
+ );
1588
+ }, (error: AxiosError) => {
1589
+ if (error.response == null) {
1590
+ reject(error);
1591
+ return;
1592
+ }
1593
+
1594
+ if (handleErrorCodeResponse(
1595
+ reject,
1596
+ error.response,
1597
+ 401,
1598
+ "ErrorResult",
1599
+ )) {
1600
+ return;
1601
+ }
1602
+ if (handleErrorCodeResponse(
1603
+ reject,
1604
+ error.response,
1605
+ 403,
1606
+ "ErrorResult",
1607
+ )) {
1608
+ return;
1609
+ }
1610
+
1611
+
1501
1612
  reject(error);
1502
1613
  });
1503
1614
  });
@@ -15,7 +15,7 @@ import axios, { AxiosError, AxiosRequestConfig, AxiosResponse } from 'axios';
15
15
  import {
16
16
  ObjectSerializer, Authentication, VoidAuth, Interceptor,
17
17
  HttpBasicAuth, HttpBearerAuth, ApiKeyAuth, OAuth, RequestFile,
18
- CreateTemplateRequest,DocumentCreated,EditTemplateRequest,EmbeddedCreateTemplateRequest,EmbeddedMergeTemplateFormRequest,EmbeddedSendCreated,EmbeddedSendTemplateFormRequest,EmbeddedTemplateCreated,EmbeddedTemplateEditRequest,EmbeddedTemplateEdited,ErrorResult,MergeAndSendForSignForm,SendForSignFromTemplateForm,TemplateCreated,TemplateProperties,TemplateRecords,TemplateTag,
18
+ CreateTemplateRequest,DocumentCreated,EditTemplateRequest,EmbeddedCreateTemplateRequest,EmbeddedMergeTemplateFormRequest,EmbeddedSendCreated,EmbeddedSendTemplateFormRequest,EmbeddedTemplateCreated,EmbeddedTemplateEditRequest,EmbeddedTemplateEdited,EmbeddedTemplatePreview,EmbeddedTemplatePreviewJsonRequest,ErrorResult,MergeAndSendForSignForm,SendForSignFromTemplateForm,TemplateCreated,TemplateProperties,TemplateRecords,TemplateTag,
19
19
  } from '../model';
20
20
 
21
21
  import {
@@ -197,6 +197,127 @@ export class TemplateApi {
197
197
  }
198
198
 
199
199
 
200
+ reject(error);
201
+ });
202
+ });
203
+ });
204
+ }
205
+ /**
206
+ *
207
+ * @summary Generates a preview URL for a template to view it.
208
+ * @param templateId The template id.
209
+ * @param embeddedTemplatePreviewJsonRequest The embedded template preview request body.
210
+ * @param options
211
+ */
212
+ public async createEmbeddedPreviewUrl (templateId: string, embeddedTemplatePreviewJsonRequest?: EmbeddedTemplatePreviewJsonRequest, options: optionsI = {headers: {}}) : Promise<EmbeddedTemplatePreview> {
213
+ embeddedTemplatePreviewJsonRequest = deserializeIfNeeded(embeddedTemplatePreviewJsonRequest, "EmbeddedTemplatePreviewJsonRequest");
214
+ const localVarPath = this.basePath + '/v1/template/createEmbeddedPreviewUrl';
215
+ let localVarQueryParameters: any = {};
216
+ let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
217
+ const produces = ['application/json'];
218
+ // give precedence to 'application/json'
219
+ if (produces.indexOf('application/json') >= 0) {
220
+ localVarHeaderParams['content-type'] = 'application/json';
221
+ } else {
222
+ localVarHeaderParams['content-type'] = produces.join(',');
223
+ }
224
+ let localVarFormParams: any = {};
225
+ let localVarBodyParams: any = undefined;
226
+
227
+ // verify required parameter 'templateId' is not null or undefined
228
+ if (templateId === null || templateId === undefined) {
229
+ throw new Error('Required parameter templateId was null or undefined when calling createEmbeddedPreviewUrl.');
230
+ }
231
+
232
+ if (templateId !== undefined) {
233
+ localVarQueryParameters['templateId'] = ObjectSerializer.serialize(templateId, "string");
234
+ }
235
+
236
+ (<any>Object).assign(localVarHeaderParams, options.headers);
237
+
238
+ let localVarUseFormData = false;
239
+
240
+ const result = generateFormData(embeddedTemplatePreviewJsonRequest, EmbeddedTemplatePreviewJsonRequest);
241
+ localVarUseFormData = result.localVarUseFormData;
242
+
243
+ let data = {};
244
+ if (localVarUseFormData) {
245
+ const formData = toFormData(result.data);
246
+ data = formData;
247
+ localVarHeaderParams = {
248
+ ...localVarHeaderParams,
249
+ ...formData.getHeaders(),
250
+ };
251
+ } else {
252
+ data = ObjectSerializer.serialize(
253
+ embeddedTemplatePreviewJsonRequest,
254
+ "EmbeddedTemplatePreviewJsonRequest"
255
+ );
256
+ }
257
+
258
+ let localVarRequestOptions: AxiosRequestConfig = {
259
+ method: 'POST',
260
+ params: localVarQueryParameters,
261
+ headers: localVarHeaderParams,
262
+ url: localVarPath,
263
+ paramsSerializer: this._useQuerystring ? queryParamsSerializer : undefined,
264
+ maxContentLength: Infinity,
265
+ maxBodyLength: Infinity,
266
+ responseType: "json",
267
+ };
268
+
269
+ if (localVarRequestOptions.method !== 'GET') {
270
+ localVarRequestOptions.data = data;
271
+ }
272
+ let authenticationPromise = Promise.resolve();
273
+
274
+ if (this.authentications["X-API-KEY"].apiKey) {
275
+ authenticationPromise = authenticationPromise.then(() => this.authentications["X-API-KEY"].applyToRequest(localVarRequestOptions));
276
+ }
277
+ if (this.authentications["Bearer"].apiKey) {
278
+ authenticationPromise = authenticationPromise.then(() => this.authentications["Bearer"].applyToRequest(localVarRequestOptions));
279
+ }
280
+ authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
281
+
282
+ let interceptorPromise = authenticationPromise;
283
+ for (const interceptor of this.interceptors) {
284
+ interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
285
+ }
286
+
287
+ return interceptorPromise.then(() => {
288
+ return new Promise<EmbeddedTemplatePreview>((resolve, reject) => {
289
+ axios.request(localVarRequestOptions)
290
+ .then((response) => {
291
+ handleSuccessfulResponse<EmbeddedTemplatePreview>(
292
+ resolve,
293
+ reject,
294
+ response,
295
+ "EmbeddedTemplatePreview",
296
+ );
297
+ }, (error: AxiosError) => {
298
+ if (error.response == null) {
299
+ reject(error);
300
+ return;
301
+ }
302
+
303
+ if (handleErrorCodeResponse(
304
+ reject,
305
+ error.response,
306
+ 200,
307
+ "EmbeddedTemplatePreview",
308
+ )) {
309
+ return;
310
+ }
311
+ if (handleErrorCodeResponse(
312
+ reject,
313
+ error.response,
314
+ 401,
315
+ "ErrorResult",
316
+ )) {
317
+ return;
318
+ }
319
+
320
+
200
321
  reject(error);
201
322
  });
202
323
  });
@@ -1328,9 +1449,10 @@ export class TemplateApi {
1328
1449
  * @param startDate Start date of the template
1329
1450
  * @param endDate End date of the template
1330
1451
  * @param brandIds BrandId(s) of the template.
1452
+ * @param sharedWithTeamId The templates can be listed by the shared teams.
1331
1453
  * @param options
1332
1454
  */
1333
- public async listTemplates (page: number, templateType?: 'mytemplates' | 'sharedtemplate' | 'all', pageSize?: number, searchKey?: string, onBehalfOf?: Array<string>, createdBy?: Array<string>, templateLabels?: Array<string>, startDate?: Date, endDate?: Date, brandIds?: Array<string>, options: optionsI = {headers: {}}) : Promise<TemplateRecords> {
1455
+ public async listTemplates (page: number, templateType?: 'mytemplates' | 'sharedtemplate' | 'all', pageSize?: number, searchKey?: string, onBehalfOf?: Array<string>, createdBy?: Array<string>, templateLabels?: Array<string>, startDate?: Date, endDate?: Date, brandIds?: Array<string>, sharedWithTeamId?: Array<string>, options: optionsI = {headers: {}}) : Promise<TemplateRecords> {
1334
1456
  const localVarPath = this.basePath + '/v1/template/list';
1335
1457
  let localVarQueryParameters: any = {};
1336
1458
  let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
@@ -1389,6 +1511,10 @@ export class TemplateApi {
1389
1511
  localVarQueryParameters['BrandIds'] = ObjectSerializer.serialize(brandIds, "Array<string>");
1390
1512
  }
1391
1513
 
1514
+ if (sharedWithTeamId !== undefined) {
1515
+ localVarQueryParameters['SharedWithTeamId'] = ObjectSerializer.serialize(sharedWithTeamId, "Array<string>");
1516
+ }
1517
+
1392
1518
  (<any>Object).assign(localVarHeaderParams, options.headers);
1393
1519
 
1394
1520
  let localVarUseFormData = false;
package/api/userApi.ts CHANGED
@@ -15,7 +15,7 @@ import axios, { AxiosError, AxiosRequestConfig, AxiosResponse } from 'axios';
15
15
  import {
16
16
  ObjectSerializer, Authentication, VoidAuth, Interceptor,
17
17
  HttpBasicAuth, HttpBearerAuth, ApiKeyAuth, OAuth, RequestFile,
18
- CreateUser,ErrorResult,UpdateUser,UpdateUserMetaData,UserProperties,UserRecords,
18
+ ChangeTeamRequest,CreateUser,ErrorResult,UpdateUser,UpdateUserMetaData,UserProperties,UserRecords,
19
19
  } from '../model';
20
20
 
21
21
  import {
@@ -197,6 +197,127 @@ export class UserApi {
197
197
  }
198
198
 
199
199
 
200
+ reject(error);
201
+ });
202
+ });
203
+ });
204
+ }
205
+ /**
206
+ *
207
+ * @summary Change users to other team.
208
+ * @param userId user Id.
209
+ * @param changeTeamRequest Change team request.
210
+ * @param options
211
+ */
212
+ public async changeTeam (userId: string, changeTeamRequest?: ChangeTeamRequest, options: optionsI = {headers: {}}) : Promise<returnTypeI> {
213
+ changeTeamRequest = deserializeIfNeeded(changeTeamRequest, "ChangeTeamRequest");
214
+ const localVarPath = this.basePath + '/v1/users/changeTeam';
215
+ let localVarQueryParameters: any = {};
216
+ let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
217
+ const produces = ['application/json'];
218
+ // give precedence to 'application/json'
219
+ if (produces.indexOf('application/json') >= 0) {
220
+ localVarHeaderParams['content-type'] = 'application/json';
221
+ } else {
222
+ localVarHeaderParams['content-type'] = produces.join(',');
223
+ }
224
+ let localVarFormParams: any = {};
225
+ let localVarBodyParams: any = undefined;
226
+
227
+ // verify required parameter 'userId' is not null or undefined
228
+ if (userId === null || userId === undefined) {
229
+ throw new Error('Required parameter userId was null or undefined when calling changeTeam.');
230
+ }
231
+
232
+ if (userId !== undefined) {
233
+ localVarQueryParameters['userId'] = ObjectSerializer.serialize(userId, "string");
234
+ }
235
+
236
+ (<any>Object).assign(localVarHeaderParams, options.headers);
237
+
238
+ let localVarUseFormData = false;
239
+
240
+ const result = generateFormData(changeTeamRequest, ChangeTeamRequest);
241
+ localVarUseFormData = result.localVarUseFormData;
242
+
243
+ let data = {};
244
+ if (localVarUseFormData) {
245
+ const formData = toFormData(result.data);
246
+ data = formData;
247
+ localVarHeaderParams = {
248
+ ...localVarHeaderParams,
249
+ ...formData.getHeaders(),
250
+ };
251
+ } else {
252
+ data = ObjectSerializer.serialize(
253
+ changeTeamRequest,
254
+ "ChangeTeamRequest"
255
+ );
256
+ }
257
+
258
+ let localVarRequestOptions: AxiosRequestConfig = {
259
+ method: 'PUT',
260
+ params: localVarQueryParameters,
261
+ headers: localVarHeaderParams,
262
+ url: localVarPath,
263
+ paramsSerializer: this._useQuerystring ? queryParamsSerializer : undefined,
264
+ maxContentLength: Infinity,
265
+ maxBodyLength: Infinity,
266
+ responseType: "json",
267
+ };
268
+
269
+ if (localVarRequestOptions.method !== 'GET') {
270
+ localVarRequestOptions.data = data;
271
+ }
272
+ let authenticationPromise = Promise.resolve();
273
+
274
+ if (this.authentications["X-API-KEY"].apiKey) {
275
+ authenticationPromise = authenticationPromise.then(() => this.authentications["X-API-KEY"].applyToRequest(localVarRequestOptions));
276
+ }
277
+ if (this.authentications["Bearer"].apiKey) {
278
+ authenticationPromise = authenticationPromise.then(() => this.authentications["Bearer"].applyToRequest(localVarRequestOptions));
279
+ }
280
+ authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
281
+
282
+ let interceptorPromise = authenticationPromise;
283
+ for (const interceptor of this.interceptors) {
284
+ interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
285
+ }
286
+
287
+ return interceptorPromise.then(() => {
288
+ return new Promise<returnTypeI>((resolve, reject) => {
289
+ axios.request(localVarRequestOptions)
290
+ .then((response) => {
291
+ handleSuccessfulResponse(
292
+ resolve,
293
+ reject,
294
+ response,
295
+
296
+ );
297
+ }, (error: AxiosError) => {
298
+ if (error.response == null) {
299
+ reject(error);
300
+ return;
301
+ }
302
+
303
+ if (handleErrorCodeResponse(
304
+ reject,
305
+ error.response,
306
+ 401,
307
+ "ErrorResult",
308
+ )) {
309
+ return;
310
+ }
311
+ if (handleErrorCodeResponse(
312
+ reject,
313
+ error.response,
314
+ 403,
315
+ "ErrorResult",
316
+ )) {
317
+ return;
318
+ }
319
+
320
+
200
321
  reject(error);
201
322
  });
202
323
  });
Binary file
@@ -21,7 +21,7 @@ export interface returnTypeI {
21
21
  body?: any;
22
22
  }
23
23
  export declare const queryParamsSerializer: (params: any) => any;
24
- export declare const USER_AGENT = "boldsign-node-sdk/3.0.0";
24
+ export declare const USER_AGENT = "boldsign-node-sdk/3.0.2";
25
25
  export declare const generateFormData: (obj: any, typemap: any) => {
26
26
  localVarUseFormData: boolean;
27
27
  data: object;
package/dist/api/apis.js CHANGED
@@ -18,7 +18,7 @@ const queryParamsSerializer = (params) => {
18
18
  return Qs.stringify(params, { arrayFormat: 'repeat' });
19
19
  };
20
20
  exports.queryParamsSerializer = queryParamsSerializer;
21
- exports.USER_AGENT = "boldsign-node-sdk/3.0.0";
21
+ exports.USER_AGENT = "boldsign-node-sdk/3.0.2";
22
22
  const generateFormData = (obj, typemap) => {
23
23
  var _a;
24
24
  const data = {};
@@ -31,6 +31,7 @@ export declare class DocumentApi {
31
31
  downloadAttachment(documentId: string, attachmentId: string, onBehalfOf?: string, options?: optionsI): Promise<Buffer>;
32
32
  downloadAuditLog(documentId: string, onBehalfOf?: string, options?: optionsI): Promise<Buffer>;
33
33
  downloadDocument(documentId: string, onBehalfOf?: string, options?: optionsI): Promise<Buffer>;
34
+ draftSend(documentId: string, options?: optionsI): Promise<returnTypeI>;
34
35
  extendExpiry(documentId: string, extendExpiry?: ExtendExpiry, options?: optionsI): Promise<returnTypeI>;
35
36
  getProperties(documentId: string, options?: optionsI): Promise<DocumentProperties>;
36
37
  getEmbeddedSignLink(documentId: string, signerEmail?: string, countryCode?: string, phoneNumber?: string, signLinkValidTill?: Date, redirectUrl?: string, options?: optionsI): Promise<EmbeddedSigningLink>;
@@ -986,6 +986,81 @@ class DocumentApi {
986
986
  });
987
987
  });
988
988
  }
989
+ draftSend(documentId_1) {
990
+ return __awaiter(this, arguments, void 0, function* (documentId, options = { headers: {} }) {
991
+ const localVarPath = this.basePath + '/v1/document/draftSend';
992
+ let localVarQueryParameters = {};
993
+ let localVarHeaderParams = Object.assign({}, this._defaultHeaders);
994
+ const produces = ['application/json'];
995
+ if (produces.indexOf('application/json') >= 0) {
996
+ localVarHeaderParams['content-type'] = 'application/json';
997
+ }
998
+ else {
999
+ localVarHeaderParams['content-type'] = produces.join(',');
1000
+ }
1001
+ let localVarFormParams = {};
1002
+ let localVarBodyParams = undefined;
1003
+ if (documentId === null || documentId === undefined) {
1004
+ throw new Error('Required parameter documentId was null or undefined when calling draftSend.');
1005
+ }
1006
+ if (documentId !== undefined) {
1007
+ localVarQueryParameters['documentId'] = model_1.ObjectSerializer.serialize(documentId, "string");
1008
+ }
1009
+ Object.assign(localVarHeaderParams, options.headers);
1010
+ let localVarUseFormData = false;
1011
+ let data = {};
1012
+ if (localVarUseFormData) {
1013
+ const formData = (0, _1.toFormData)(localVarFormParams);
1014
+ data = formData;
1015
+ localVarHeaderParams = Object.assign(Object.assign({}, localVarHeaderParams), formData.getHeaders());
1016
+ }
1017
+ let localVarRequestOptions = {
1018
+ method: 'POST',
1019
+ params: localVarQueryParameters,
1020
+ headers: localVarHeaderParams,
1021
+ url: localVarPath,
1022
+ paramsSerializer: this._useQuerystring ? _1.queryParamsSerializer : undefined,
1023
+ maxContentLength: Infinity,
1024
+ maxBodyLength: Infinity,
1025
+ responseType: "json",
1026
+ };
1027
+ if (localVarRequestOptions.method !== 'GET') {
1028
+ localVarRequestOptions.data = data;
1029
+ }
1030
+ let authenticationPromise = Promise.resolve();
1031
+ if (this.authentications["X-API-KEY"].apiKey) {
1032
+ authenticationPromise = authenticationPromise.then(() => this.authentications["X-API-KEY"].applyToRequest(localVarRequestOptions));
1033
+ }
1034
+ if (this.authentications["Bearer"].apiKey) {
1035
+ authenticationPromise = authenticationPromise.then(() => this.authentications["Bearer"].applyToRequest(localVarRequestOptions));
1036
+ }
1037
+ authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
1038
+ let interceptorPromise = authenticationPromise;
1039
+ for (const interceptor of this.interceptors) {
1040
+ interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
1041
+ }
1042
+ return interceptorPromise.then(() => {
1043
+ return new Promise((resolve, reject) => {
1044
+ axios_1.default.request(localVarRequestOptions)
1045
+ .then((response) => {
1046
+ handleSuccessfulResponse(resolve, reject, response);
1047
+ }, (error) => {
1048
+ if (error.response == null) {
1049
+ reject(error);
1050
+ return;
1051
+ }
1052
+ if (handleErrorCodeResponse(reject, error.response, 401, "ErrorResult")) {
1053
+ return;
1054
+ }
1055
+ if (handleErrorCodeResponse(reject, error.response, 403, "ErrorResult")) {
1056
+ return;
1057
+ }
1058
+ reject(error);
1059
+ });
1060
+ });
1061
+ });
1062
+ });
1063
+ }
989
1064
  extendExpiry(documentId_1, extendExpiry_1) {
990
1065
  return __awaiter(this, arguments, void 0, function* (documentId, extendExpiry, options = { headers: {} }) {
991
1066
  extendExpiry = deserializeIfNeeded(extendExpiry, "ExtendExpiry");