boldsign 3.0.1 → 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 (149) hide show
  1. package/.openapi-generator/FILES +7 -0
  2. package/LICENSE +1 -1
  3. package/README.md +8 -0
  4. package/api/apis.ts +1 -1
  5. package/api/templateApi.ts +128 -2
  6. package/boldsign-3.0.2.tgz +0 -0
  7. package/dist/api/apis.d.ts +1 -1
  8. package/dist/api/apis.js +1 -1
  9. package/dist/api/templateApi.d.ts +3 -2
  10. package/dist/api/templateApi.js +86 -2
  11. package/dist/api/templateApi.js.map +1 -1
  12. package/dist/examples/embeddedCreatePreviewUrl.d.ts +1 -0
  13. package/dist/examples/embeddedCreatePreviewUrl.js +29 -0
  14. package/dist/examples/embeddedCreatePreviewUrl.js.map +1 -0
  15. package/dist/model/attachmentInfo.d.ts +2 -2
  16. package/dist/model/attachmentInfo.js +6 -6
  17. package/dist/model/attachmentInfo.js.map +1 -1
  18. package/dist/model/createTemplateRequest.d.ts +2 -0
  19. package/dist/model/createTemplateRequest.js +5 -0
  20. package/dist/model/createTemplateRequest.js.map +1 -1
  21. package/dist/model/documentProperties.d.ts +2 -0
  22. package/dist/model/documentProperties.js +5 -0
  23. package/dist/model/documentProperties.js.map +1 -1
  24. package/dist/model/documentSigner.d.ts +7 -1
  25. package/dist/model/documentSigner.js +19 -4
  26. package/dist/model/documentSigner.js.map +1 -1
  27. package/dist/model/documentSignerDetails.d.ts +8 -0
  28. package/dist/model/documentSignerDetails.js +21 -0
  29. package/dist/model/documentSignerDetails.js.map +1 -1
  30. package/dist/model/editTemplateRequest.d.ts +2 -0
  31. package/dist/model/editTemplateRequest.js +5 -0
  32. package/dist/model/editTemplateRequest.js.map +1 -1
  33. package/dist/model/embeddedCreateTemplateRequest.d.ts +2 -0
  34. package/dist/model/embeddedCreateTemplateRequest.js +5 -0
  35. package/dist/model/embeddedCreateTemplateRequest.js.map +1 -1
  36. package/dist/model/embeddedDocumentRequest.d.ts +2 -0
  37. package/dist/model/embeddedDocumentRequest.js +5 -0
  38. package/dist/model/embeddedDocumentRequest.js.map +1 -1
  39. package/dist/model/embeddedMergeTemplateFormRequest.d.ts +2 -0
  40. package/dist/model/embeddedMergeTemplateFormRequest.js +5 -0
  41. package/dist/model/embeddedMergeTemplateFormRequest.js.map +1 -1
  42. package/dist/model/embeddedSendTemplateFormRequest.d.ts +2 -0
  43. package/dist/model/embeddedSendTemplateFormRequest.js +5 -0
  44. package/dist/model/embeddedSendTemplateFormRequest.js.map +1 -1
  45. package/dist/model/embeddedTemplatePreview.d.ts +14 -0
  46. package/dist/model/embeddedTemplatePreview.js +18 -0
  47. package/dist/model/embeddedTemplatePreview.js.map +1 -0
  48. package/dist/model/embeddedTemplatePreviewJsonRequest.d.ts +15 -0
  49. package/dist/model/embeddedTemplatePreviewJsonRequest.js +23 -0
  50. package/dist/model/embeddedTemplatePreviewJsonRequest.js.map +1 -0
  51. package/dist/model/font.d.ts +2 -2
  52. package/dist/model/groupSigner.d.ts +30 -0
  53. package/dist/model/groupSigner.js +59 -0
  54. package/dist/model/groupSigner.js.map +1 -0
  55. package/dist/model/groupSignerSettings.d.ts +15 -0
  56. package/dist/model/groupSignerSettings.js +23 -0
  57. package/dist/model/groupSignerSettings.js.map +1 -0
  58. package/dist/model/index.d.ts +8 -1
  59. package/dist/model/index.js +31 -2
  60. package/dist/model/index.js.map +1 -1
  61. package/dist/model/mergeAndSendForSignForm.d.ts +2 -0
  62. package/dist/model/mergeAndSendForSignForm.js +5 -0
  63. package/dist/model/mergeAndSendForSignForm.js.map +1 -1
  64. package/dist/model/role.d.ts +6 -0
  65. package/dist/model/role.js +15 -0
  66. package/dist/model/role.js.map +1 -1
  67. package/dist/model/roles.d.ts +8 -0
  68. package/dist/model/roles.js +20 -0
  69. package/dist/model/roles.js.map +1 -1
  70. package/dist/model/sendForSign.d.ts +2 -0
  71. package/dist/model/sendForSign.js +5 -0
  72. package/dist/model/sendForSign.js.map +1 -1
  73. package/dist/model/sendForSignFromTemplateForm.d.ts +2 -0
  74. package/dist/model/sendForSignFromTemplateForm.js +5 -0
  75. package/dist/model/sendForSignFromTemplateForm.js.map +1 -1
  76. package/dist/model/templateGroupSigner.d.ts +15 -0
  77. package/dist/model/templateGroupSigner.js +23 -0
  78. package/dist/model/templateGroupSigner.js.map +1 -0
  79. package/dist/model/templateProperties.d.ts +4 -0
  80. package/dist/model/templateProperties.js +10 -0
  81. package/dist/model/templateProperties.js.map +1 -1
  82. package/dist/model/templateRole.d.ts +6 -0
  83. package/dist/model/templateRole.js +15 -0
  84. package/dist/model/templateRole.js.map +1 -1
  85. package/dist/model/templateSharing.d.ts +15 -0
  86. package/dist/model/templateSharing.js +18 -0
  87. package/dist/model/templateSharing.js.map +1 -0
  88. package/dist/model/templateSignerDetails.d.ts +3 -0
  89. package/dist/model/templateSignerDetails.js +10 -0
  90. package/dist/model/templateSignerDetails.js.map +1 -1
  91. package/dist/model/templateTeamShare.d.ts +22 -0
  92. package/dist/model/templateTeamShare.js +31 -0
  93. package/dist/model/templateTeamShare.js.map +1 -0
  94. package/docs/AttachmentInfo.md +2 -2
  95. package/docs/CreateTemplateRequest.md +1 -0
  96. package/docs/DocumentProperties.md +1 -0
  97. package/docs/DocumentSigner.md +3 -1
  98. package/docs/DocumentSignerDetails.md +3 -0
  99. package/docs/EditTemplateRequest.md +1 -0
  100. package/docs/EmbeddedCreateTemplateRequest.md +1 -0
  101. package/docs/EmbeddedDocumentRequest.md +1 -0
  102. package/docs/EmbeddedMergeTemplateFormRequest.md +1 -0
  103. package/docs/EmbeddedSendTemplateFormRequest.md +1 -0
  104. package/docs/EmbeddedTemplatePreview.md +11 -0
  105. package/docs/EmbeddedTemplatePreviewJsonRequest.md +12 -0
  106. package/docs/GroupSigner.md +17 -0
  107. package/docs/GroupSignerSettings.md +12 -0
  108. package/docs/MergeAndSendForSignForm.md +1 -0
  109. package/docs/Role.md +2 -0
  110. package/docs/Roles.md +3 -0
  111. package/docs/SendForSign.md +1 -0
  112. package/docs/SendForSignFromTemplateForm.md +1 -0
  113. package/docs/TemplateApi.md +36 -1
  114. package/docs/TemplateGroupSigner.md +12 -0
  115. package/docs/TemplateProperties.md +2 -0
  116. package/docs/TemplateRole.md +2 -0
  117. package/docs/TemplateSharing.md +11 -0
  118. package/docs/TemplateSignerDetails.md +2 -0
  119. package/docs/TemplateTeamShare.md +12 -0
  120. package/examples/embeddedCreatePreviewUrl.ts +15 -0
  121. package/model/attachmentInfo.ts +8 -8
  122. package/model/createTemplateRequest.ts +7 -0
  123. package/model/documentProperties.ts +7 -0
  124. package/model/documentSigner.ts +21 -5
  125. package/model/documentSignerDetails.ts +23 -0
  126. package/model/editTemplateRequest.ts +7 -0
  127. package/model/embeddedCreateTemplateRequest.ts +7 -0
  128. package/model/embeddedDocumentRequest.ts +7 -0
  129. package/model/embeddedMergeTemplateFormRequest.ts +7 -0
  130. package/model/embeddedSendTemplateFormRequest.ts +7 -0
  131. package/model/embeddedTemplatePreview.ts +31 -0
  132. package/model/embeddedTemplatePreviewJsonRequest.ts +37 -0
  133. package/model/font.ts +2 -2
  134. package/model/groupSigner.ts +77 -0
  135. package/model/groupSignerSettings.ts +37 -0
  136. package/model/index.ts +28 -0
  137. package/model/mergeAndSendForSignForm.ts +7 -0
  138. package/model/role.ts +16 -0
  139. package/model/roles.ts +23 -0
  140. package/model/sendForSign.ts +7 -0
  141. package/model/sendForSignFromTemplateForm.ts +7 -0
  142. package/model/templateGroupSigner.ts +37 -0
  143. package/model/templateProperties.ts +14 -0
  144. package/model/templateRole.ts +16 -0
  145. package/model/templateSharing.ts +32 -0
  146. package/model/templateSignerDetails.ts +13 -0
  147. package/model/templateTeamShare.ts +44 -0
  148. package/package.json +1 -1
  149. package/boldsign-3.0.1.tgz +0 -0
@@ -81,6 +81,8 @@ model/embeddedSigningLink.ts
81
81
  model/embeddedTemplateCreated.ts
82
82
  model/embeddedTemplateEditRequest.ts
83
83
  model/embeddedTemplateEdited.ts
84
+ model/embeddedTemplatePreview.ts
85
+ model/embeddedTemplatePreviewJsonRequest.ts
84
86
  model/errorResult.ts
85
87
  model/existingFormField.ts
86
88
  model/extendExpiry.ts
@@ -90,6 +92,8 @@ model/formField.ts
90
92
  model/formFieldPermission.ts
91
93
  model/formGroup.ts
92
94
  model/formulaFieldSettings.ts
95
+ model/groupSigner.ts
96
+ model/groupSignerSettings.ts
93
97
  model/idDocument.ts
94
98
  model/idReport.ts
95
99
  model/idVerification.ts
@@ -137,14 +141,17 @@ model/templateCC.ts
137
141
  model/templateCreated.ts
138
142
  model/templateFiles.ts
139
143
  model/templateFormFields.ts
144
+ model/templateGroupSigner.ts
140
145
  model/templateProperties.ts
141
146
  model/templateRecords.ts
142
147
  model/templateRole.ts
143
148
  model/templateSenderDetail.ts
144
149
  model/templateSenderDetails.ts
145
150
  model/templateSharedTemplateDetail.ts
151
+ model/templateSharing.ts
146
152
  model/templateSignerDetails.ts
147
153
  model/templateTag.ts
154
+ model/templateTeamShare.ts
148
155
  model/textTagDefinition.ts
149
156
  model/textTagOffset.ts
150
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
@@ -120,6 +120,7 @@ All URIs are relative to *https://api.boldsign.com*
120
120
  | *TeamsApi* | [**listTeams**](./docs/TeamsApi.md#listteams) | **GET** /v1/teams/list | List Teams. |
121
121
  | *TeamsApi* | [**updateTeam**](./docs/TeamsApi.md#updateteam) | **PUT** /v1/teams/update | Update Team. |
122
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. |
123
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. |
124
125
  | *TemplateApi* | [**createEmbeddedTemplateUrl**](./docs/TemplateApi.md#createembeddedtemplateurl) | **POST** /v1/template/createEmbeddedTemplateUrl | Generates a create URL to embeds template create process into your application. |
125
126
  | *TemplateApi* | [**createTemplate**](./docs/TemplateApi.md#createtemplate) | **POST** /v1/template/create | Creates a new template. |
@@ -210,6 +211,8 @@ All URIs are relative to *https://api.boldsign.com*
210
211
  - [EmbeddedTemplateCreated](./docs/EmbeddedTemplateCreated.md)
211
212
  - [EmbeddedTemplateEditRequest](./docs/EmbeddedTemplateEditRequest.md)
212
213
  - [EmbeddedTemplateEdited](./docs/EmbeddedTemplateEdited.md)
214
+ - [EmbeddedTemplatePreview](./docs/EmbeddedTemplatePreview.md)
215
+ - [EmbeddedTemplatePreviewJsonRequest](./docs/EmbeddedTemplatePreviewJsonRequest.md)
213
216
  - [ErrorResult](./docs/ErrorResult.md)
214
217
  - [ExistingFormField](./docs/ExistingFormField.md)
215
218
  - [ExtendExpiry](./docs/ExtendExpiry.md)
@@ -219,6 +222,8 @@ All URIs are relative to *https://api.boldsign.com*
219
222
  - [FormFieldPermission](./docs/FormFieldPermission.md)
220
223
  - [FormGroup](./docs/FormGroup.md)
221
224
  - [FormulaFieldSettings](./docs/FormulaFieldSettings.md)
225
+ - [GroupSigner](./docs/GroupSigner.md)
226
+ - [GroupSignerSettings](./docs/GroupSignerSettings.md)
222
227
  - [IdDocument](./docs/IdDocument.md)
223
228
  - [IdReport](./docs/IdReport.md)
224
229
  - [IdVerification](./docs/IdVerification.md)
@@ -264,14 +269,17 @@ All URIs are relative to *https://api.boldsign.com*
264
269
  - [TemplateCreated](./docs/TemplateCreated.md)
265
270
  - [TemplateFiles](./docs/TemplateFiles.md)
266
271
  - [TemplateFormFields](./docs/TemplateFormFields.md)
272
+ - [TemplateGroupSigner](./docs/TemplateGroupSigner.md)
267
273
  - [TemplateProperties](./docs/TemplateProperties.md)
268
274
  - [TemplateRecords](./docs/TemplateRecords.md)
269
275
  - [TemplateRole](./docs/TemplateRole.md)
270
276
  - [TemplateSenderDetail](./docs/TemplateSenderDetail.md)
271
277
  - [TemplateSenderDetails](./docs/TemplateSenderDetails.md)
272
278
  - [TemplateSharedTemplateDetail](./docs/TemplateSharedTemplateDetail.md)
279
+ - [TemplateSharing](./docs/TemplateSharing.md)
273
280
  - [TemplateSignerDetails](./docs/TemplateSignerDetails.md)
274
281
  - [TemplateTag](./docs/TemplateTag.md)
282
+ - [TemplateTeamShare](./docs/TemplateTeamShare.md)
275
283
  - [TextTagDefinition](./docs/TextTagDefinition.md)
276
284
  - [TextTagOffset](./docs/TextTagOffset.md)
277
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.1";
27
+ export const USER_AGENT = "boldsign-node-sdk/3.0.2";
28
28
 
29
29
  /**
30
30
  * Generates an object containing form data.
@@ -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;
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.1";
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.1";
21
+ exports.USER_AGENT = "boldsign-node-sdk/3.0.2";
22
22
  const generateFormData = (obj, typemap) => {
23
23
  var _a;
24
24
  const data = {};
@@ -1,4 +1,4 @@
1
- import { Authentication, Interceptor, ApiKeyAuth, CreateTemplateRequest, DocumentCreated, EditTemplateRequest, EmbeddedCreateTemplateRequest, EmbeddedMergeTemplateFormRequest, EmbeddedSendCreated, EmbeddedSendTemplateFormRequest, EmbeddedTemplateCreated, EmbeddedTemplateEditRequest, EmbeddedTemplateEdited, MergeAndSendForSignForm, SendForSignFromTemplateForm, TemplateCreated, TemplateProperties, TemplateRecords, TemplateTag } from '../model';
1
+ import { Authentication, Interceptor, ApiKeyAuth, CreateTemplateRequest, DocumentCreated, EditTemplateRequest, EmbeddedCreateTemplateRequest, EmbeddedMergeTemplateFormRequest, EmbeddedSendCreated, EmbeddedSendTemplateFormRequest, EmbeddedTemplateCreated, EmbeddedTemplateEditRequest, EmbeddedTemplateEdited, EmbeddedTemplatePreview, EmbeddedTemplatePreviewJsonRequest, MergeAndSendForSignForm, SendForSignFromTemplateForm, TemplateCreated, TemplateProperties, TemplateRecords, TemplateTag } from '../model';
2
2
  import { optionsI, returnTypeI } from './';
3
3
  export declare class TemplateApi {
4
4
  protected _basePath: string;
@@ -21,6 +21,7 @@ export declare class TemplateApi {
21
21
  setAccessToken(accessToken: string): void;
22
22
  addInterceptor(interceptor: Interceptor): void;
23
23
  addTag(templateTag?: TemplateTag, options?: optionsI): Promise<returnTypeI>;
24
+ createEmbeddedPreviewUrl(templateId: string, embeddedTemplatePreviewJsonRequest?: EmbeddedTemplatePreviewJsonRequest, options?: optionsI): Promise<EmbeddedTemplatePreview>;
24
25
  createEmbeddedRequestUrlTemplate(templateId: string, embeddedSendTemplateFormRequest?: EmbeddedSendTemplateFormRequest, options?: optionsI): Promise<EmbeddedSendCreated>;
25
26
  createEmbeddedTemplateUrl(embeddedCreateTemplateRequest?: EmbeddedCreateTemplateRequest, options?: optionsI): Promise<EmbeddedTemplateCreated>;
26
27
  createTemplate(createTemplateRequest?: CreateTemplateRequest, options?: optionsI): Promise<TemplateCreated>;
@@ -30,7 +31,7 @@ export declare class TemplateApi {
30
31
  editTemplate(templateId: string, editTemplateRequest: EditTemplateRequest, options?: optionsI): Promise<returnTypeI>;
31
32
  getEmbeddedTemplateEditUrl(templateId: string, embeddedTemplateEditRequest?: EmbeddedTemplateEditRequest, options?: optionsI): Promise<EmbeddedTemplateEdited>;
32
33
  getProperties(templateId: string, options?: optionsI): Promise<TemplateProperties>;
33
- 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): Promise<TemplateRecords>;
34
+ 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): Promise<TemplateRecords>;
34
35
  mergeAndSend(mergeAndSendForSignForm?: MergeAndSendForSignForm, options?: optionsI): Promise<DocumentCreated>;
35
36
  mergeCreateEmbeddedRequestUrlTemplate(embeddedMergeTemplateFormRequest?: EmbeddedMergeTemplateFormRequest, options?: optionsI): Promise<EmbeddedSendCreated>;
36
37
  sendUsingTemplate(templateId: string, sendForSignFromTemplateForm?: SendForSignFromTemplateForm, options?: optionsI): Promise<DocumentCreated>;
@@ -134,6 +134,87 @@ class TemplateApi {
134
134
  });
135
135
  });
136
136
  }
137
+ createEmbeddedPreviewUrl(templateId_1, embeddedTemplatePreviewJsonRequest_1) {
138
+ return __awaiter(this, arguments, void 0, function* (templateId, embeddedTemplatePreviewJsonRequest, options = { headers: {} }) {
139
+ embeddedTemplatePreviewJsonRequest = deserializeIfNeeded(embeddedTemplatePreviewJsonRequest, "EmbeddedTemplatePreviewJsonRequest");
140
+ const localVarPath = this.basePath + '/v1/template/createEmbeddedPreviewUrl';
141
+ let localVarQueryParameters = {};
142
+ let localVarHeaderParams = Object.assign({}, this._defaultHeaders);
143
+ const produces = ['application/json'];
144
+ if (produces.indexOf('application/json') >= 0) {
145
+ localVarHeaderParams['content-type'] = 'application/json';
146
+ }
147
+ else {
148
+ localVarHeaderParams['content-type'] = produces.join(',');
149
+ }
150
+ let localVarFormParams = {};
151
+ let localVarBodyParams = undefined;
152
+ if (templateId === null || templateId === undefined) {
153
+ throw new Error('Required parameter templateId was null or undefined when calling createEmbeddedPreviewUrl.');
154
+ }
155
+ if (templateId !== undefined) {
156
+ localVarQueryParameters['templateId'] = model_1.ObjectSerializer.serialize(templateId, "string");
157
+ }
158
+ Object.assign(localVarHeaderParams, options.headers);
159
+ let localVarUseFormData = false;
160
+ const result = (0, _1.generateFormData)(embeddedTemplatePreviewJsonRequest, model_1.EmbeddedTemplatePreviewJsonRequest);
161
+ localVarUseFormData = result.localVarUseFormData;
162
+ let data = {};
163
+ if (localVarUseFormData) {
164
+ const formData = (0, _1.toFormData)(result.data);
165
+ data = formData;
166
+ localVarHeaderParams = Object.assign(Object.assign({}, localVarHeaderParams), formData.getHeaders());
167
+ }
168
+ else {
169
+ data = model_1.ObjectSerializer.serialize(embeddedTemplatePreviewJsonRequest, "EmbeddedTemplatePreviewJsonRequest");
170
+ }
171
+ let localVarRequestOptions = {
172
+ method: 'POST',
173
+ params: localVarQueryParameters,
174
+ headers: localVarHeaderParams,
175
+ url: localVarPath,
176
+ paramsSerializer: this._useQuerystring ? _1.queryParamsSerializer : undefined,
177
+ maxContentLength: Infinity,
178
+ maxBodyLength: Infinity,
179
+ responseType: "json",
180
+ };
181
+ if (localVarRequestOptions.method !== 'GET') {
182
+ localVarRequestOptions.data = data;
183
+ }
184
+ let authenticationPromise = Promise.resolve();
185
+ if (this.authentications["X-API-KEY"].apiKey) {
186
+ authenticationPromise = authenticationPromise.then(() => this.authentications["X-API-KEY"].applyToRequest(localVarRequestOptions));
187
+ }
188
+ if (this.authentications["Bearer"].apiKey) {
189
+ authenticationPromise = authenticationPromise.then(() => this.authentications["Bearer"].applyToRequest(localVarRequestOptions));
190
+ }
191
+ authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
192
+ let interceptorPromise = authenticationPromise;
193
+ for (const interceptor of this.interceptors) {
194
+ interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
195
+ }
196
+ return interceptorPromise.then(() => {
197
+ return new Promise((resolve, reject) => {
198
+ axios_1.default.request(localVarRequestOptions)
199
+ .then((response) => {
200
+ handleSuccessfulResponse(resolve, reject, response, "EmbeddedTemplatePreview");
201
+ }, (error) => {
202
+ if (error.response == null) {
203
+ reject(error);
204
+ return;
205
+ }
206
+ if (handleErrorCodeResponse(reject, error.response, 200, "EmbeddedTemplatePreview")) {
207
+ return;
208
+ }
209
+ if (handleErrorCodeResponse(reject, error.response, 401, "ErrorResult")) {
210
+ return;
211
+ }
212
+ reject(error);
213
+ });
214
+ });
215
+ });
216
+ });
217
+ }
137
218
  createEmbeddedRequestUrlTemplate(templateId_1, embeddedSendTemplateFormRequest_1) {
138
219
  return __awaiter(this, arguments, void 0, function* (templateId, embeddedSendTemplateFormRequest, options = { headers: {} }) {
139
220
  embeddedSendTemplateFormRequest = deserializeIfNeeded(embeddedSendTemplateFormRequest, "EmbeddedSendTemplateFormRequest");
@@ -863,8 +944,8 @@ class TemplateApi {
863
944
  });
864
945
  });
865
946
  }
866
- listTemplates(page_1, templateType_1, pageSize_1, searchKey_1, onBehalfOf_1, createdBy_1, templateLabels_1, startDate_1, endDate_1, brandIds_1) {
867
- return __awaiter(this, arguments, void 0, function* (page, templateType, pageSize, searchKey, onBehalfOf, createdBy, templateLabels, startDate, endDate, brandIds, options = { headers: {} }) {
947
+ listTemplates(page_1, templateType_1, pageSize_1, searchKey_1, onBehalfOf_1, createdBy_1, templateLabels_1, startDate_1, endDate_1, brandIds_1, sharedWithTeamId_1) {
948
+ return __awaiter(this, arguments, void 0, function* (page, templateType, pageSize, searchKey, onBehalfOf, createdBy, templateLabels, startDate, endDate, brandIds, sharedWithTeamId, options = { headers: {} }) {
868
949
  const localVarPath = this.basePath + '/v1/template/list';
869
950
  let localVarQueryParameters = {};
870
951
  let localVarHeaderParams = Object.assign({}, this._defaultHeaders);
@@ -910,6 +991,9 @@ class TemplateApi {
910
991
  if (brandIds !== undefined) {
911
992
  localVarQueryParameters['BrandIds'] = model_1.ObjectSerializer.serialize(brandIds, "Array<string>");
912
993
  }
994
+ if (sharedWithTeamId !== undefined) {
995
+ localVarQueryParameters['SharedWithTeamId'] = model_1.ObjectSerializer.serialize(sharedWithTeamId, "Array<string>");
996
+ }
913
997
  Object.assign(localVarHeaderParams, options.headers);
914
998
  let localVarUseFormData = false;
915
999
  let data = {};