boldsign 3.1.0-beta.1 → 3.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +1 -29
- package/README.md +10 -40
- package/api/apis.ts +2 -2
- package/api/brandingApi.ts +42 -2
- package/api/documentApi.ts +3 -119
- package/api/groupContactsApi.ts +5 -5
- package/api/templateApi.ts +1 -143
- package/api/userApi.ts +1 -1
- package/boldsign-3.1.1.tgz +0 -0
- package/dist/api/apis.d.ts +1 -1
- package/dist/api/apis.js +1 -1
- package/dist/api/apis.js.map +1 -1
- package/dist/api/brandingApi.d.ts +2 -2
- package/dist/api/brandingApi.js +28 -4
- package/dist/api/brandingApi.js.map +1 -1
- package/dist/api/documentApi.d.ts +0 -1
- package/dist/api/documentApi.js +3 -81
- package/dist/api/documentApi.js.map +1 -1
- package/dist/api/groupContactsApi.js +5 -5
- package/dist/api/groupContactsApi.js.map +1 -1
- package/dist/api/templateApi.d.ts +1 -2
- package/dist/api/templateApi.js +0 -90
- package/dist/api/templateApi.js.map +1 -1
- package/dist/api/userApi.js +1 -1
- package/dist/api/userApi.js.map +1 -1
- package/dist/examples/contactGroupUpdate.js +1 -1
- package/dist/examples/contactGroupsCreate.js +1 -1
- package/dist/examples/contactGroupsCreate.js.map +1 -1
- package/dist/examples/documentEdit.js +3 -3
- package/dist/examples/documentEdit.js.map +1 -1
- package/dist/examples/{documentCancelEditing.js → draftSend.js} +6 -6
- package/dist/examples/draftSend.js.map +1 -0
- package/dist/examples/{templateCreateEmbeddedPreviewUrl.js → embeddedCreatePreviewUrl.js} +5 -6
- package/dist/examples/embeddedCreatePreviewUrl.js.map +1 -0
- package/dist/examples/senderIdentityProperties.js +4 -4
- package/dist/examples/senderIdentityProperties.js.map +1 -1
- package/dist/examples/templateDownload.js +1 -1
- package/dist/examples/templateDownload.js.map +1 -1
- package/dist/model/auditTrail.d.ts +4 -0
- package/dist/model/auditTrail.js +20 -0
- package/dist/model/auditTrail.js.map +1 -1
- package/dist/model/brandCreated.d.ts +0 -1
- package/dist/model/brandCreated.js +0 -5
- package/dist/model/brandCreated.js.map +1 -1
- package/dist/model/document.d.ts +2 -0
- package/dist/model/document.js +10 -0
- package/dist/model/document.js.map +1 -1
- package/dist/model/documentProperties.d.ts +2 -0
- package/dist/model/documentProperties.js +10 -0
- package/dist/model/documentProperties.js.map +1 -1
- package/dist/model/editDocumentRequest.d.ts +2 -4
- package/dist/model/editDocumentRequest.js +0 -2
- package/dist/model/editDocumentRequest.js.map +1 -1
- package/dist/model/editDocumentSigner.d.ts +3 -6
- package/dist/model/editDocumentSigner.js +0 -3
- package/dist/model/editDocumentSigner.js.map +1 -1
- package/dist/model/editFormField.d.ts +6 -12
- package/dist/model/editFormField.js +8 -15
- package/dist/model/editFormField.js.map +1 -1
- package/dist/model/index.d.ts +2 -30
- package/dist/model/index.js +7 -108
- package/dist/model/index.js.map +1 -1
- package/dist/model/{documentCcWebhookModel.d.ts → problemDetails.d.ts} +6 -3
- package/dist/model/problemDetails.js +38 -0
- package/dist/model/problemDetails.js.map +1 -0
- package/dist/model/{documentSender.d.ts → signatureFrameSettings.d.ts} +5 -5
- package/dist/model/signatureFrameSettings.js +39 -0
- package/dist/model/signatureFrameSettings.js.map +1 -0
- package/dist/model/templateSignerDetails.d.ts +2 -0
- package/dist/model/templateSignerDetails.js +5 -0
- package/dist/model/templateSignerDetails.js.map +1 -1
- package/dist/model/viewBrandDetails.d.ts +2 -0
- package/dist/model/viewBrandDetails.js +5 -0
- package/dist/model/viewBrandDetails.js.map +1 -1
- package/dist/tests/performance/performanceApiTest.spec.js +368 -0
- package/dist/tests/performance/performanceApiTest.spec.js.map +1 -0
- package/docs/AuditTrail.md +4 -0
- package/docs/BrandCreated.md +0 -1
- package/docs/BrandingApi.md +10 -2
- package/docs/Document.md +2 -0
- package/docs/DocumentApi.md +3 -37
- package/docs/DocumentProperties.md +2 -0
- package/docs/EditFormField.md +1 -2
- package/docs/GroupContactsApi.md +5 -5
- package/docs/{ErrorResponse.md → ProblemDetails.md} +6 -3
- package/docs/SignatureFrameSettings.md +14 -0
- package/docs/TemplateApi.md +0 -34
- package/docs/TemplateSignerDetails.md +1 -0
- package/docs/UserApi.md +1 -1
- package/docs/ViewBrandDetails.md +1 -0
- package/examples/contactGroupUpdate.ts +1 -1
- package/examples/contactGroupsCreate.ts +1 -1
- package/examples/documentEdit.ts +3 -3
- package/examples/{documentCancelEditing.ts → draftSend.ts} +5 -7
- package/examples/embeddedCreatePreviewUrl.ts +15 -0
- package/examples/senderIdentityProperties.ts +6 -6
- package/examples/templateDownload.ts +1 -1
- package/model/auditTrail.ts +24 -0
- package/model/brandCreated.ts +0 -6
- package/model/document.ts +12 -0
- package/model/documentProperties.ts +12 -0
- package/model/editDocumentRequest.ts +2 -4
- package/model/editDocumentSigner.ts +3 -6
- package/model/editFormField.ts +11 -22
- package/model/index.ts +3 -104
- package/model/{senderIdentityCreator.ts → problemDetails.ts} +20 -14
- package/model/{formFieldPermissionWebhookModel.ts → signatureFrameSettings.ts} +17 -11
- package/model/templateSignerDetails.ts +7 -0
- package/model/viewBrandDetails.ts +7 -0
- package/package.json +1 -1
- package/tests/performance/performanceApiTest.spec.ts +362 -0
- package/auth/OAuthClient.ts +0 -137
- package/auth/OAuthToken.ts +0 -17
- package/auth/PKCEHelper.ts +0 -36
- package/boldsign-3.1.0-beta.1.tgz +0 -0
- package/dist/auth/OAuthClient.d.ts +0 -36
- package/dist/auth/OAuthClient.js +0 -152
- package/dist/auth/OAuthClient.js.map +0 -1
- package/dist/auth/OAuthToken.d.ts +0 -9
- package/dist/auth/OAuthToken.js +0 -15
- package/dist/auth/OAuthToken.js.map +0 -1
- package/dist/auth/PKCEHelper.d.ts +0 -7
- package/dist/auth/PKCEHelper.js +0 -58
- package/dist/auth/PKCEHelper.js.map +0 -1
- package/dist/examples/TemplateShare.js +0 -34
- package/dist/examples/TemplateShare.js.map +0 -1
- package/dist/examples/documentCancelEditing.js.map +0 -1
- package/dist/examples/documentDraftSend.js +0 -27
- package/dist/examples/documentDraftSend.js.map +0 -1
- package/dist/examples/oAuthAuthorizationFlow.d.ts +0 -1
- package/dist/examples/oAuthAuthorizationFlow.js +0 -49
- package/dist/examples/oAuthAuthorizationFlow.js.map +0 -1
- package/dist/examples/oAuthClientCredentialFlow.d.ts +0 -1
- package/dist/examples/oAuthClientCredentialFlow.js +0 -42
- package/dist/examples/oAuthClientCredentialFlow.js.map +0 -1
- package/dist/examples/templateCreateEmbeddedPreviewUrl.d.ts +0 -1
- package/dist/examples/templateCreateEmbeddedPreviewUrl.js.map +0 -1
- package/dist/model/behalfOfWebhookModel.d.ts +0 -15
- package/dist/model/behalfOfWebhookModel.js +0 -23
- package/dist/model/behalfOfWebhookModel.js.map +0 -1
- package/dist/model/documentCcWebhookModel.js +0 -23
- package/dist/model/documentCcWebhookModel.js.map +0 -1
- package/dist/model/documentEvent.d.ts +0 -66
- package/dist/model/documentEvent.js +0 -162
- package/dist/model/documentEvent.js.map +0 -1
- package/dist/model/documentGroupSignerWebhookModel.d.ts +0 -31
- package/dist/model/documentGroupSignerWebhookModel.js +0 -64
- package/dist/model/documentGroupSignerWebhookModel.js.map +0 -1
- package/dist/model/documentSender.js +0 -33
- package/dist/model/documentSender.js.map +0 -1
- package/dist/model/documentSignerWebhookModel.d.ts +0 -53
- package/dist/model/documentSignerWebhookModel.js +0 -154
- package/dist/model/documentSignerWebhookModel.js.map +0 -1
- package/dist/model/errorResponse.d.ts +0 -15
- package/dist/model/errorResponse.js +0 -23
- package/dist/model/errorResponse.js.map +0 -1
- package/dist/model/formFieldPermissionWebhookModel.d.ts +0 -16
- package/dist/model/formFieldPermissionWebhookModel.js +0 -28
- package/dist/model/formFieldPermissionWebhookModel.js.map +0 -1
- package/dist/model/groupSignerSettingsWebhookModel.d.ts +0 -15
- package/dist/model/groupSignerSettingsWebhookModel.js +0 -23
- package/dist/model/groupSignerSettingsWebhookModel.js.map +0 -1
- package/dist/model/iWebhookData.d.ts +0 -14
- package/dist/model/iWebhookData.js +0 -18
- package/dist/model/iWebhookData.js.map +0 -1
- package/dist/model/idVerificationSignerWebhookModel.d.ts +0 -22
- package/dist/model/idVerificationSignerWebhookModel.js +0 -58
- package/dist/model/idVerificationSignerWebhookModel.js.map +0 -1
- package/dist/model/identityVerificationEvent.d.ts +0 -33
- package/dist/model/identityVerificationEvent.js +0 -60
- package/dist/model/identityVerificationEvent.js.map +0 -1
- package/dist/model/phoneNumberWebhookModel.d.ts +0 -15
- package/dist/model/phoneNumberWebhookModel.js +0 -23
- package/dist/model/phoneNumberWebhookModel.js.map +0 -1
- package/dist/model/senderIdentityCreator.d.ts +0 -17
- package/dist/model/senderIdentityCreator.js +0 -33
- package/dist/model/senderIdentityCreator.js.map +0 -1
- package/dist/model/senderIdentityEvent.d.ts +0 -29
- package/dist/model/senderIdentityEvent.js +0 -78
- package/dist/model/senderIdentityEvent.js.map +0 -1
- package/dist/model/signerAuthenticationWebhookModel.d.ts +0 -15
- package/dist/model/signerAuthenticationWebhookModel.js +0 -23
- package/dist/model/signerAuthenticationWebhookModel.js.map +0 -1
- package/dist/model/templateCcWebhookModel.d.ts +0 -16
- package/dist/model/templateCcWebhookModel.js +0 -28
- package/dist/model/templateCcWebhookModel.js.map +0 -1
- package/dist/model/templateEvent.d.ts +0 -54
- package/dist/model/templateEvent.js +0 -148
- package/dist/model/templateEvent.js.map +0 -1
- package/dist/model/templateGroupSignerWebhookModel.d.ts +0 -15
- package/dist/model/templateGroupSignerWebhookModel.js +0 -23
- package/dist/model/templateGroupSignerWebhookModel.js.map +0 -1
- package/dist/model/templateSender.d.ts +0 -17
- package/dist/model/templateSender.js +0 -33
- package/dist/model/templateSender.js.map +0 -1
- package/dist/model/templateShareErrorResponse.d.ts +0 -17
- package/dist/model/templateShareErrorResponse.js +0 -33
- package/dist/model/templateShareErrorResponse.js.map +0 -1
- package/dist/model/templateShareRequest.d.ts +0 -15
- package/dist/model/templateShareRequest.js +0 -18
- package/dist/model/templateShareRequest.js.map +0 -1
- package/dist/model/templateSigner.d.ts +0 -44
- package/dist/model/templateSigner.js +0 -119
- package/dist/model/templateSigner.js.map +0 -1
- package/dist/model/templateTeamShareRequest.d.ts +0 -26
- package/dist/model/templateTeamShareRequest.js +0 -40
- package/dist/model/templateTeamShareRequest.js.map +0 -1
- package/dist/model/webhookActorDetails.d.ts +0 -25
- package/dist/model/webhookActorDetails.js +0 -34
- package/dist/model/webhookActorDetails.js.map +0 -1
- package/dist/model/webhookContext.d.ts +0 -51
- package/dist/model/webhookContext.js +0 -63
- package/dist/model/webhookContext.js.map +0 -1
- package/dist/model/webhookEvent.d.ts +0 -21
- package/dist/model/webhookEvent.js +0 -33
- package/dist/model/webhookEvent.js.map +0 -1
- package/dist/model/webhookEventData.d.ts +0 -88
- package/dist/model/webhookEventData.js +0 -260
- package/dist/model/webhookEventData.js.map +0 -1
- package/dist/model/webhookEventMetadata.d.ts +0 -56
- package/dist/model/webhookEventMetadata.js +0 -78
- package/dist/model/webhookEventMetadata.js.map +0 -1
- package/dist/tests/integration/WebhookApiTest.spec.d.ts +0 -1
- package/dist/tests/integration/WebhookApiTest.spec.js +0 -218
- package/dist/tests/integration/WebhookApiTest.spec.js.map +0 -1
- package/docs/BehalfOfWebhookModel.md +0 -12
- package/docs/DocumentCcWebhookModel.md +0 -12
- package/docs/DocumentEvent.md +0 -35
- package/docs/DocumentGroupSignerWebhookModel.md +0 -18
- package/docs/DocumentSender.md +0 -14
- package/docs/DocumentSignerWebhookModel.md +0 -36
- package/docs/FormFieldPermissionWebhookModel.md +0 -13
- package/docs/GroupSignerSettingsWebhookModel.md +0 -12
- package/docs/IWebhookData.md +0 -11
- package/docs/IdVerificationSignerWebhookModel.md +0 -19
- package/docs/IdentityVerificationEvent.md +0 -17
- package/docs/PhoneNumberWebhookModel.md +0 -12
- package/docs/SenderIdentityCreator.md +0 -14
- package/docs/SenderIdentityEvent.md +0 -23
- package/docs/SignerAuthenticationWebhookModel.md +0 -12
- package/docs/TemplateCcWebhookModel.md +0 -13
- package/docs/TemplateEvent.md +0 -34
- package/docs/TemplateGroupSignerWebhookModel.md +0 -12
- package/docs/TemplateSender.md +0 -14
- package/docs/TemplateShareErrorResponse.md +0 -14
- package/docs/TemplateShareRequest.md +0 -11
- package/docs/TemplateSigner.md +0 -29
- package/docs/TemplateTeamShareRequest.md +0 -13
- package/docs/WebhookActorDetails.md +0 -12
- package/docs/WebhookContext.md +0 -13
- package/docs/WebhookEvent.md +0 -14
- package/docs/WebhookEventData.md +0 -54
- package/docs/WebhookEventMetadata.md +0 -15
- package/examples/TemplateShare.ts +0 -23
- package/examples/documentDraftSend.ts +0 -16
- package/examples/oAuthAuthorizationFlow.ts +0 -45
- package/examples/oAuthClientCredentialFlow.ts +0 -34
- package/examples/templateCreateEmbeddedPreviewUrl.ts +0 -17
- package/model/behalfOfWebhookModel.ts +0 -37
- package/model/documentCcWebhookModel.ts +0 -37
- package/model/documentEvent.ts +0 -201
- package/model/documentGroupSignerWebhookModel.ts +0 -83
- package/model/documentSender.ts +0 -49
- package/model/documentSignerWebhookModel.ts +0 -195
- package/model/errorResponse.ts +0 -37
- package/model/groupSignerSettingsWebhookModel.ts +0 -37
- package/model/iWebhookData.ts +0 -31
- package/model/idVerificationSignerWebhookModel.ts +0 -79
- package/model/identityVerificationEvent.ts +0 -80
- package/model/phoneNumberWebhookModel.ts +0 -37
- package/model/senderIdentityEvent.ts +0 -104
- package/model/signerAuthenticationWebhookModel.ts +0 -37
- package/model/templateCcWebhookModel.ts +0 -43
- package/model/templateEvent.ts +0 -186
- package/model/templateGroupSignerWebhookModel.ts +0 -37
- package/model/templateSender.ts +0 -49
- package/model/templateShareErrorResponse.ts +0 -49
- package/model/templateShareRequest.ts +0 -32
- package/model/templateSigner.ts +0 -151
- package/model/templateTeamShareRequest.ts +0 -53
- package/model/webhookActorDetails.ts +0 -47
- package/model/webhookContext.ts +0 -78
- package/model/webhookEvent.ts +0 -53
- package/model/webhookEventData.ts +0 -322
- package/model/webhookEventMetadata.ts +0 -93
- package/tests/documents/document_event.json +0 -109
- package/tests/documents/identity_event.json +0 -56
- package/tests/documents/sender_event.json +0 -23
- package/tests/documents/template_event.json +0 -55
- package/tests/integration/WebhookApiTest.spec.ts +0 -187
- /package/dist/examples/{TemplateShare.d.ts → draftSend.d.ts} +0 -0
- /package/dist/examples/{documentCancelEditing.d.ts → embeddedCreatePreviewUrl.d.ts} +0 -0
- /package/dist/{examples/documentDraftSend.d.ts → tests/performance/performanceApiTest.spec.d.ts} +0 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -27,7 +27,6 @@ model/base64File.ts
|
|
|
27
27
|
model/behalfDocument.ts
|
|
28
28
|
model/behalfDocumentRecords.ts
|
|
29
29
|
model/behalfOf.ts
|
|
30
|
-
model/behalfOfWebhookModel.ts
|
|
31
30
|
model/billingViewModel.ts
|
|
32
31
|
model/brandCreated.ts
|
|
33
32
|
model/brandCustomFieldDetails.ts
|
|
@@ -57,23 +56,18 @@ model/deleteCustomFieldReply.ts
|
|
|
57
56
|
model/document.ts
|
|
58
57
|
model/documentCC.ts
|
|
59
58
|
model/documentCcDetails.ts
|
|
60
|
-
model/documentCcWebhookModel.ts
|
|
61
59
|
model/documentCreated.ts
|
|
62
60
|
model/documentEdited.ts
|
|
63
|
-
model/documentEvent.ts
|
|
64
61
|
model/documentExpirySettings.ts
|
|
65
62
|
model/documentFiles.ts
|
|
66
63
|
model/documentFormFields.ts
|
|
67
|
-
model/documentGroupSignerWebhookModel.ts
|
|
68
64
|
model/documentInfo.ts
|
|
69
65
|
model/documentProperties.ts
|
|
70
66
|
model/documentReassign.ts
|
|
71
67
|
model/documentRecords.ts
|
|
72
|
-
model/documentSender.ts
|
|
73
68
|
model/documentSenderDetail.ts
|
|
74
69
|
model/documentSigner.ts
|
|
75
70
|
model/documentSignerDetails.ts
|
|
76
|
-
model/documentSignerWebhookModel.ts
|
|
77
71
|
model/documentTags.ts
|
|
78
72
|
model/downloadImageRequest.ts
|
|
79
73
|
model/editDocumentFile.ts
|
|
@@ -99,7 +93,6 @@ model/embeddedTemplateEditRequest.ts
|
|
|
99
93
|
model/embeddedTemplateEdited.ts
|
|
100
94
|
model/embeddedTemplatePreview.ts
|
|
101
95
|
model/embeddedTemplatePreviewJsonRequest.ts
|
|
102
|
-
model/errorResponse.ts
|
|
103
96
|
model/errorResult.ts
|
|
104
97
|
model/existingFormField.ts
|
|
105
98
|
model/extendExpiry.ts
|
|
@@ -107,7 +100,6 @@ model/fileInfo.ts
|
|
|
107
100
|
model/font.ts
|
|
108
101
|
model/formField.ts
|
|
109
102
|
model/formFieldPermission.ts
|
|
110
|
-
model/formFieldPermissionWebhookModel.ts
|
|
111
103
|
model/formGroup.ts
|
|
112
104
|
model/formulaFieldSettings.ts
|
|
113
105
|
model/getGroupContactDetails.ts
|
|
@@ -116,14 +108,10 @@ model/groupContactDetails.ts
|
|
|
116
108
|
model/groupContactsList.ts
|
|
117
109
|
model/groupSigner.ts
|
|
118
110
|
model/groupSignerSettings.ts
|
|
119
|
-
model/groupSignerSettingsWebhookModel.ts
|
|
120
111
|
model/groupUser.ts
|
|
121
|
-
model/iWebhookData.ts
|
|
122
112
|
model/idDocument.ts
|
|
123
113
|
model/idReport.ts
|
|
124
114
|
model/idVerificationDetails.ts
|
|
125
|
-
model/idVerificationSignerWebhookModel.ts
|
|
126
|
-
model/identityVerificationEvent.ts
|
|
127
115
|
model/identityVerificationSettings.ts
|
|
128
116
|
model/imageInfo.ts
|
|
129
117
|
model/index.ts
|
|
@@ -135,7 +123,6 @@ model/modificationDetails.ts
|
|
|
135
123
|
model/notificationSettings.ts
|
|
136
124
|
model/pageDetails.ts
|
|
137
125
|
model/phoneNumber.ts
|
|
138
|
-
model/phoneNumberWebhookModel.ts
|
|
139
126
|
model/prefillField.ts
|
|
140
127
|
model/prefillFieldRequest.ts
|
|
141
128
|
model/recipientChangeLog.ts
|
|
@@ -151,12 +138,10 @@ model/roles.ts
|
|
|
151
138
|
model/sendForSign.ts
|
|
152
139
|
model/sendForSignFromTemplateForm.ts
|
|
153
140
|
model/senderIdentityCreated.ts
|
|
154
|
-
model/senderIdentityCreator.ts
|
|
155
|
-
model/senderIdentityEvent.ts
|
|
156
141
|
model/senderIdentityList.ts
|
|
157
142
|
model/senderIdentityViewModel.ts
|
|
143
|
+
model/signatureFrameSettings.ts
|
|
158
144
|
model/signerAuthenticationSettings.ts
|
|
159
|
-
model/signerAuthenticationWebhookModel.ts
|
|
160
145
|
model/size.ts
|
|
161
146
|
model/teamCreated.ts
|
|
162
147
|
model/teamDocumentRecords.ts
|
|
@@ -168,28 +153,20 @@ model/teamUsers.ts
|
|
|
168
153
|
model/teams.ts
|
|
169
154
|
model/template.ts
|
|
170
155
|
model/templateCC.ts
|
|
171
|
-
model/templateCcWebhookModel.ts
|
|
172
156
|
model/templateCreated.ts
|
|
173
|
-
model/templateEvent.ts
|
|
174
157
|
model/templateFiles.ts
|
|
175
158
|
model/templateFormFields.ts
|
|
176
159
|
model/templateGroupSigner.ts
|
|
177
|
-
model/templateGroupSignerWebhookModel.ts
|
|
178
160
|
model/templateProperties.ts
|
|
179
161
|
model/templateRecords.ts
|
|
180
162
|
model/templateRole.ts
|
|
181
|
-
model/templateSender.ts
|
|
182
163
|
model/templateSenderDetail.ts
|
|
183
164
|
model/templateSenderDetails.ts
|
|
184
|
-
model/templateShareErrorResponse.ts
|
|
185
|
-
model/templateShareRequest.ts
|
|
186
165
|
model/templateSharedTemplateDetail.ts
|
|
187
166
|
model/templateSharing.ts
|
|
188
|
-
model/templateSigner.ts
|
|
189
167
|
model/templateSignerDetails.ts
|
|
190
168
|
model/templateTag.ts
|
|
191
169
|
model/templateTeamShare.ts
|
|
192
|
-
model/templateTeamShareRequest.ts
|
|
193
170
|
model/textTagDefinition.ts
|
|
194
171
|
model/textTagOffset.ts
|
|
195
172
|
model/updateGroupContact.ts
|
|
@@ -203,10 +180,5 @@ model/validation.ts
|
|
|
203
180
|
model/verificationDataRequest.ts
|
|
204
181
|
model/viewBrandDetails.ts
|
|
205
182
|
model/viewCustomFieldDetails.ts
|
|
206
|
-
model/webhookActorDetails.ts
|
|
207
|
-
model/webhookContext.ts
|
|
208
|
-
model/webhookEvent.ts
|
|
209
|
-
model/webhookEventData.ts
|
|
210
|
-
model/webhookEventMetadata.ts
|
|
211
183
|
package.json
|
|
212
184
|
tsconfig.json
|
package/README.md
CHANGED
|
@@ -85,18 +85,17 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
85
85
|
| *DocumentApi* | [**addAuthentication**](./docs/DocumentApi.md#addauthentication) | **PATCH** /v1/document/addAuthentication | The add authentication to recipient. |
|
|
86
86
|
| *DocumentApi* | [**addTag**](./docs/DocumentApi.md#addtag) | **PATCH** /v1/document/addTags | Add the Tags in Documents. |
|
|
87
87
|
| *DocumentApi* | [**behalfDocuments**](./docs/DocumentApi.md#behalfdocuments) | **GET** /v1/document/behalfList | Gets the behalf documents. |
|
|
88
|
-
| *DocumentApi* | [**cancelEditing**](./docs/DocumentApi.md#cancelediting) | **POST** /v1-beta/document/cancelEditing | Cancels editing for a document that is currently in edit-mode. |
|
|
89
88
|
| *DocumentApi* | [**changeAccessCode**](./docs/DocumentApi.md#changeaccesscode) | **PATCH** /v1/document/changeAccessCode | Changes the access code for the given document signer. |
|
|
90
89
|
| *DocumentApi* | [**changeRecipient**](./docs/DocumentApi.md#changerecipient) | **PATCH** /v1/document/changeRecipient | Change recipient details of a document. |
|
|
91
|
-
| *DocumentApi* | [**createEmbeddedEditUrl**](./docs/DocumentApi.md#createembeddedediturl) | **POST** /v1
|
|
90
|
+
| *DocumentApi* | [**createEmbeddedEditUrl**](./docs/DocumentApi.md#createembeddedediturl) | **POST** /v1/document/createEmbeddedEditUrl | Generates an embedded edit URL that allows the document editing process to be integrated into your application. |
|
|
92
91
|
| *DocumentApi* | [**createEmbeddedRequestUrlDocument**](./docs/DocumentApi.md#createembeddedrequesturldocument) | **POST** /v1/document/createEmbeddedRequestUrl | Generates a send URL which embeds document sending process into your application. |
|
|
93
92
|
| *DocumentApi* | [**deleteDocument**](./docs/DocumentApi.md#deletedocument) | **DELETE** /v1/document/delete | Delete the document. |
|
|
94
93
|
| *DocumentApi* | [**deleteTag**](./docs/DocumentApi.md#deletetag) | **DELETE** /v1/document/deleteTags | Delete the Tags in Documents. |
|
|
95
94
|
| *DocumentApi* | [**downloadAttachment**](./docs/DocumentApi.md#downloadattachment) | **GET** /v1/document/downloadAttachment | Download the Attachment. |
|
|
96
95
|
| *DocumentApi* | [**downloadAuditLog**](./docs/DocumentApi.md#downloadauditlog) | **GET** /v1/document/downloadAuditLog | Download the audit trail document. |
|
|
97
96
|
| *DocumentApi* | [**downloadDocument**](./docs/DocumentApi.md#downloaddocument) | **GET** /v1/document/download | Download the document. |
|
|
98
|
-
| *DocumentApi* | [**draftSend**](./docs/DocumentApi.md#draftsend) | **POST** /v1
|
|
99
|
-
| *DocumentApi* | [**editDocument**](./docs/DocumentApi.md#editdocument) | **PUT** /v1
|
|
97
|
+
| *DocumentApi* | [**draftSend**](./docs/DocumentApi.md#draftsend) | **POST** /v1/document/draftSend | Sends a draft-status document out for signature. |
|
|
98
|
+
| *DocumentApi* | [**editDocument**](./docs/DocumentApi.md#editdocument) | **PUT** /v1/document/edit | Edit and updates an existing document. |
|
|
100
99
|
| *DocumentApi* | [**extendExpiry**](./docs/DocumentApi.md#extendexpiry) | **PATCH** /v1/document/extendExpiry | Extends the expiration date of the document. |
|
|
101
100
|
| *DocumentApi* | [**getProperties**](./docs/DocumentApi.md#getproperties) | **GET** /v1/document/properties | Get summary of the document. |
|
|
102
101
|
| *DocumentApi* | [**getEmbeddedSignLink**](./docs/DocumentApi.md#getembeddedsignlink) | **GET** /v1/document/getEmbeddedSignLink | Get sign link for Embedded Sign. |
|
|
@@ -107,11 +106,11 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
107
106
|
| *DocumentApi* | [**revokeDocument**](./docs/DocumentApi.md#revokedocument) | **POST** /v1/document/revoke | Revoke the document. |
|
|
108
107
|
| *DocumentApi* | [**sendDocument**](./docs/DocumentApi.md#senddocument) | **POST** /v1/document/send | Sends the document for sign. |
|
|
109
108
|
| *DocumentApi* | [**teamDocuments**](./docs/DocumentApi.md#teamdocuments) | **GET** /v1/document/teamlist | Get user Team documents. |
|
|
110
|
-
| *GroupContactsApi* | [**createGroupContact**](./docs/GroupContactsApi.md#creategroupcontact) | **POST** /v1
|
|
111
|
-
| *GroupContactsApi* | [**deleteGroupContact**](./docs/GroupContactsApi.md#deletegroupcontact) | **DELETE** /v1
|
|
112
|
-
| *GroupContactsApi* | [**getGroupContact**](./docs/GroupContactsApi.md#getgroupcontact) | **GET** /v1
|
|
113
|
-
| *GroupContactsApi* | [**groupContactList**](./docs/GroupContactsApi.md#groupcontactlist) | **GET** /v1
|
|
114
|
-
| *GroupContactsApi* | [**updateGroupContact**](./docs/GroupContactsApi.md#updategroupcontact) | **PUT** /v1
|
|
109
|
+
| *GroupContactsApi* | [**createGroupContact**](./docs/GroupContactsApi.md#creategroupcontact) | **POST** /v1/contactGroups/create | Create a new Group Contact. |
|
|
110
|
+
| *GroupContactsApi* | [**deleteGroupContact**](./docs/GroupContactsApi.md#deletegroupcontact) | **DELETE** /v1/contactGroups/delete | Deletes a Group Contact. |
|
|
111
|
+
| *GroupContactsApi* | [**getGroupContact**](./docs/GroupContactsApi.md#getgroupcontact) | **GET** /v1/contactGroups/get | Get Summary of the Group Contact. |
|
|
112
|
+
| *GroupContactsApi* | [**groupContactList**](./docs/GroupContactsApi.md#groupcontactlist) | **GET** /v1/contactGroups/list | List Group Contacts. |
|
|
113
|
+
| *GroupContactsApi* | [**updateGroupContact**](./docs/GroupContactsApi.md#updategroupcontact) | **PUT** /v1/contactGroups/update | Update the Group Contact. |
|
|
115
114
|
| *IdentityVerificationApi* | [**createEmbeddedVerificationUrl**](./docs/IdentityVerificationApi.md#createembeddedverificationurl) | **POST** /v1/identityVerification/createEmbeddedVerificationUrl | Generate a URL that embeds manual ID verification for the specified document signer into your application. |
|
|
116
115
|
| *IdentityVerificationApi* | [**image**](./docs/IdentityVerificationApi.md#image) | **POST** /v1/identityVerification/image | Retrieve the uploaded ID verification document or selfie image for the specified document signer using the file ID. |
|
|
117
116
|
| *IdentityVerificationApi* | [**report**](./docs/IdentityVerificationApi.md#report) | **POST** /v1/identityVerification/report | Retrieve the ID verification report for the specified document signer. |
|
|
@@ -142,9 +141,8 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
142
141
|
| *TemplateApi* | [**mergeAndSend**](./docs/TemplateApi.md#mergeandsend) | **POST** /v1/template/mergeAndSend | Send the document by merging multiple templates. |
|
|
143
142
|
| *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. |
|
|
144
143
|
| *TemplateApi* | [**sendUsingTemplate**](./docs/TemplateApi.md#sendusingtemplate) | **POST** /v1/template/send | Send a document for signature using a Template. |
|
|
145
|
-
| *TemplateApi* | [**shareTemplate**](./docs/TemplateApi.md#sharetemplate) | **PATCH** /v1-beta/template/share | Share a template with teams and manage permissions. |
|
|
146
144
|
| *UserApi* | [**cancelInvitation**](./docs/UserApi.md#cancelinvitation) | **POST** /v1/users/cancelInvitation | Cancel the users invitation. |
|
|
147
|
-
| *UserApi* | [**changeTeam**](./docs/UserApi.md#changeteam) | **PUT** /v1
|
|
145
|
+
| *UserApi* | [**changeTeam**](./docs/UserApi.md#changeteam) | **PUT** /v1/users/changeTeam | Change users to other team. |
|
|
148
146
|
| *UserApi* | [**createUser**](./docs/UserApi.md#createuser) | **POST** /v1/users/create | Create the user. |
|
|
149
147
|
| *UserApi* | [**getUser**](./docs/UserApi.md#getuser) | **GET** /v1/users/get | Get summary of the user. |
|
|
150
148
|
| *UserApi* | [**listUsers**](./docs/UserApi.md#listusers) | **GET** /v1/users/list | List user documents. |
|
|
@@ -165,7 +163,6 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
165
163
|
- [BehalfDocument](./docs/BehalfDocument.md)
|
|
166
164
|
- [BehalfDocumentRecords](./docs/BehalfDocumentRecords.md)
|
|
167
165
|
- [BehalfOf](./docs/BehalfOf.md)
|
|
168
|
-
- [BehalfOfWebhookModel](./docs/BehalfOfWebhookModel.md)
|
|
169
166
|
- [BillingViewModel](./docs/BillingViewModel.md)
|
|
170
167
|
- [BrandCreated](./docs/BrandCreated.md)
|
|
171
168
|
- [BrandCustomFieldDetails](./docs/BrandCustomFieldDetails.md)
|
|
@@ -195,23 +192,18 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
195
192
|
- [Document](./docs/Document.md)
|
|
196
193
|
- [DocumentCC](./docs/DocumentCC.md)
|
|
197
194
|
- [DocumentCcDetails](./docs/DocumentCcDetails.md)
|
|
198
|
-
- [DocumentCcWebhookModel](./docs/DocumentCcWebhookModel.md)
|
|
199
195
|
- [DocumentCreated](./docs/DocumentCreated.md)
|
|
200
196
|
- [DocumentEdited](./docs/DocumentEdited.md)
|
|
201
|
-
- [DocumentEvent](./docs/DocumentEvent.md)
|
|
202
197
|
- [DocumentExpirySettings](./docs/DocumentExpirySettings.md)
|
|
203
198
|
- [DocumentFiles](./docs/DocumentFiles.md)
|
|
204
199
|
- [DocumentFormFields](./docs/DocumentFormFields.md)
|
|
205
|
-
- [DocumentGroupSignerWebhookModel](./docs/DocumentGroupSignerWebhookModel.md)
|
|
206
200
|
- [DocumentInfo](./docs/DocumentInfo.md)
|
|
207
201
|
- [DocumentProperties](./docs/DocumentProperties.md)
|
|
208
202
|
- [DocumentReassign](./docs/DocumentReassign.md)
|
|
209
203
|
- [DocumentRecords](./docs/DocumentRecords.md)
|
|
210
|
-
- [DocumentSender](./docs/DocumentSender.md)
|
|
211
204
|
- [DocumentSenderDetail](./docs/DocumentSenderDetail.md)
|
|
212
205
|
- [DocumentSigner](./docs/DocumentSigner.md)
|
|
213
206
|
- [DocumentSignerDetails](./docs/DocumentSignerDetails.md)
|
|
214
|
-
- [DocumentSignerWebhookModel](./docs/DocumentSignerWebhookModel.md)
|
|
215
207
|
- [DocumentTags](./docs/DocumentTags.md)
|
|
216
208
|
- [DownloadImageRequest](./docs/DownloadImageRequest.md)
|
|
217
209
|
- [EditDocumentFile](./docs/EditDocumentFile.md)
|
|
@@ -237,7 +229,6 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
237
229
|
- [EmbeddedTemplateEdited](./docs/EmbeddedTemplateEdited.md)
|
|
238
230
|
- [EmbeddedTemplatePreview](./docs/EmbeddedTemplatePreview.md)
|
|
239
231
|
- [EmbeddedTemplatePreviewJsonRequest](./docs/EmbeddedTemplatePreviewJsonRequest.md)
|
|
240
|
-
- [ErrorResponse](./docs/ErrorResponse.md)
|
|
241
232
|
- [ErrorResult](./docs/ErrorResult.md)
|
|
242
233
|
- [ExistingFormField](./docs/ExistingFormField.md)
|
|
243
234
|
- [ExtendExpiry](./docs/ExtendExpiry.md)
|
|
@@ -245,7 +236,6 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
245
236
|
- [Font](./docs/Font.md)
|
|
246
237
|
- [FormField](./docs/FormField.md)
|
|
247
238
|
- [FormFieldPermission](./docs/FormFieldPermission.md)
|
|
248
|
-
- [FormFieldPermissionWebhookModel](./docs/FormFieldPermissionWebhookModel.md)
|
|
249
239
|
- [FormGroup](./docs/FormGroup.md)
|
|
250
240
|
- [FormulaFieldSettings](./docs/FormulaFieldSettings.md)
|
|
251
241
|
- [GetGroupContactDetails](./docs/GetGroupContactDetails.md)
|
|
@@ -254,14 +244,10 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
254
244
|
- [GroupContactsList](./docs/GroupContactsList.md)
|
|
255
245
|
- [GroupSigner](./docs/GroupSigner.md)
|
|
256
246
|
- [GroupSignerSettings](./docs/GroupSignerSettings.md)
|
|
257
|
-
- [GroupSignerSettingsWebhookModel](./docs/GroupSignerSettingsWebhookModel.md)
|
|
258
247
|
- [GroupUser](./docs/GroupUser.md)
|
|
259
|
-
- [IWebhookData](./docs/IWebhookData.md)
|
|
260
248
|
- [IdDocument](./docs/IdDocument.md)
|
|
261
249
|
- [IdReport](./docs/IdReport.md)
|
|
262
250
|
- [IdVerificationDetails](./docs/IdVerificationDetails.md)
|
|
263
|
-
- [IdVerificationSignerWebhookModel](./docs/IdVerificationSignerWebhookModel.md)
|
|
264
|
-
- [IdentityVerificationEvent](./docs/IdentityVerificationEvent.md)
|
|
265
251
|
- [IdentityVerificationSettings](./docs/IdentityVerificationSettings.md)
|
|
266
252
|
- [ImageInfo](./docs/ImageInfo.md)
|
|
267
253
|
- [MergeAndSendForSignForm](./docs/MergeAndSendForSignForm.md)
|
|
@@ -271,7 +257,6 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
271
257
|
- [NotificationSettings](./docs/NotificationSettings.md)
|
|
272
258
|
- [PageDetails](./docs/PageDetails.md)
|
|
273
259
|
- [PhoneNumber](./docs/PhoneNumber.md)
|
|
274
|
-
- [PhoneNumberWebhookModel](./docs/PhoneNumberWebhookModel.md)
|
|
275
260
|
- [PrefillField](./docs/PrefillField.md)
|
|
276
261
|
- [PrefillFieldRequest](./docs/PrefillFieldRequest.md)
|
|
277
262
|
- [RecipientChangeLog](./docs/RecipientChangeLog.md)
|
|
@@ -287,12 +272,10 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
287
272
|
- [SendForSign](./docs/SendForSign.md)
|
|
288
273
|
- [SendForSignFromTemplateForm](./docs/SendForSignFromTemplateForm.md)
|
|
289
274
|
- [SenderIdentityCreated](./docs/SenderIdentityCreated.md)
|
|
290
|
-
- [SenderIdentityCreator](./docs/SenderIdentityCreator.md)
|
|
291
|
-
- [SenderIdentityEvent](./docs/SenderIdentityEvent.md)
|
|
292
275
|
- [SenderIdentityList](./docs/SenderIdentityList.md)
|
|
293
276
|
- [SenderIdentityViewModel](./docs/SenderIdentityViewModel.md)
|
|
277
|
+
- [SignatureFrameSettings](./docs/SignatureFrameSettings.md)
|
|
294
278
|
- [SignerAuthenticationSettings](./docs/SignerAuthenticationSettings.md)
|
|
295
|
-
- [SignerAuthenticationWebhookModel](./docs/SignerAuthenticationWebhookModel.md)
|
|
296
279
|
- [Size](./docs/Size.md)
|
|
297
280
|
- [TeamCreated](./docs/TeamCreated.md)
|
|
298
281
|
- [TeamDocumentRecords](./docs/TeamDocumentRecords.md)
|
|
@@ -304,28 +287,20 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
304
287
|
- [Teams](./docs/Teams.md)
|
|
305
288
|
- [Template](./docs/Template.md)
|
|
306
289
|
- [TemplateCC](./docs/TemplateCC.md)
|
|
307
|
-
- [TemplateCcWebhookModel](./docs/TemplateCcWebhookModel.md)
|
|
308
290
|
- [TemplateCreated](./docs/TemplateCreated.md)
|
|
309
|
-
- [TemplateEvent](./docs/TemplateEvent.md)
|
|
310
291
|
- [TemplateFiles](./docs/TemplateFiles.md)
|
|
311
292
|
- [TemplateFormFields](./docs/TemplateFormFields.md)
|
|
312
293
|
- [TemplateGroupSigner](./docs/TemplateGroupSigner.md)
|
|
313
|
-
- [TemplateGroupSignerWebhookModel](./docs/TemplateGroupSignerWebhookModel.md)
|
|
314
294
|
- [TemplateProperties](./docs/TemplateProperties.md)
|
|
315
295
|
- [TemplateRecords](./docs/TemplateRecords.md)
|
|
316
296
|
- [TemplateRole](./docs/TemplateRole.md)
|
|
317
|
-
- [TemplateSender](./docs/TemplateSender.md)
|
|
318
297
|
- [TemplateSenderDetail](./docs/TemplateSenderDetail.md)
|
|
319
298
|
- [TemplateSenderDetails](./docs/TemplateSenderDetails.md)
|
|
320
|
-
- [TemplateShareErrorResponse](./docs/TemplateShareErrorResponse.md)
|
|
321
|
-
- [TemplateShareRequest](./docs/TemplateShareRequest.md)
|
|
322
299
|
- [TemplateSharedTemplateDetail](./docs/TemplateSharedTemplateDetail.md)
|
|
323
300
|
- [TemplateSharing](./docs/TemplateSharing.md)
|
|
324
|
-
- [TemplateSigner](./docs/TemplateSigner.md)
|
|
325
301
|
- [TemplateSignerDetails](./docs/TemplateSignerDetails.md)
|
|
326
302
|
- [TemplateTag](./docs/TemplateTag.md)
|
|
327
303
|
- [TemplateTeamShare](./docs/TemplateTeamShare.md)
|
|
328
|
-
- [TemplateTeamShareRequest](./docs/TemplateTeamShareRequest.md)
|
|
329
304
|
- [TextTagDefinition](./docs/TextTagDefinition.md)
|
|
330
305
|
- [TextTagOffset](./docs/TextTagOffset.md)
|
|
331
306
|
- [UpdateGroupContact](./docs/UpdateGroupContact.md)
|
|
@@ -339,11 +314,6 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
339
314
|
- [VerificationDataRequest](./docs/VerificationDataRequest.md)
|
|
340
315
|
- [ViewBrandDetails](./docs/ViewBrandDetails.md)
|
|
341
316
|
- [ViewCustomFieldDetails](./docs/ViewCustomFieldDetails.md)
|
|
342
|
-
- [WebhookActorDetails](./docs/WebhookActorDetails.md)
|
|
343
|
-
- [WebhookContext](./docs/WebhookContext.md)
|
|
344
|
-
- [WebhookEvent](./docs/WebhookEvent.md)
|
|
345
|
-
- [WebhookEventData](./docs/WebhookEventData.md)
|
|
346
|
-
- [WebhookEventMetadata](./docs/WebhookEventMetadata.md)
|
|
347
317
|
|
|
348
318
|
## Authorization
|
|
349
319
|
|
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.1.
|
|
27
|
+
export const USER_AGENT = "boldsign-node-sdk/3.1.1";
|
|
28
28
|
|
|
29
29
|
/**
|
|
30
30
|
* Generates an object containing form data.
|
|
@@ -133,7 +133,7 @@ export const generateFormData = (
|
|
|
133
133
|
});
|
|
134
134
|
return;
|
|
135
135
|
}
|
|
136
|
-
|
|
136
|
+
|
|
137
137
|
/**
|
|
138
138
|
* Everything else that is not binary data (file uploads) can be
|
|
139
139
|
* serialized to JSON and sent over. This helps reduce complexity
|
package/api/brandingApi.ts
CHANGED
|
@@ -232,9 +232,13 @@ export class BrandingApi {
|
|
|
232
232
|
* @param documentExpirySettingsReminderCount
|
|
233
233
|
* @param customDomainSettingsDomainName
|
|
234
234
|
* @param customDomainSettingsFromName
|
|
235
|
+
* @param signatureFrameSettingsEnableSignatureFrame
|
|
236
|
+
* @param signatureFrameSettingsShowRecipientName
|
|
237
|
+
* @param signatureFrameSettingsShowRecipientEmail
|
|
238
|
+
* @param signatureFrameSettingsShowTimeStamp
|
|
235
239
|
* @param options
|
|
236
240
|
*/
|
|
237
|
-
public async createBrand (brandName: string, brandLogo: RequestFile, backgroundColor?: string, buttonColor?: string, buttonTextColor?: string, emailDisplayName?: string, disclaimerDescription?: string, disclaimerTitle?: string, redirectUrl?: string, isDefault?: boolean, canHideTagLine?: boolean, combineAuditTrail?: boolean, combineAttachments?: boolean, excludeAuditTrailFromEmail?: boolean, emailSignedDocument?: string, documentTimeZone?: string, showBuiltInFormFields?: boolean, allowCustomFieldCreation?: boolean, showSharedCustomFields?: boolean, hideDecline?: boolean, hideSave?: boolean, documentExpirySettingsExpiryDateType?: string, documentExpirySettingsExpiryValue?: number, documentExpirySettingsEnableDefaultExpiryAlert?: boolean, documentExpirySettingsEnableAutoReminder?: boolean, documentExpirySettingsReminderDays?: number, documentExpirySettingsReminderCount?: number, customDomainSettingsDomainName?: string, customDomainSettingsFromName?: string, options: optionsI = {headers: {}}) : Promise<BrandCreated> {
|
|
241
|
+
public async createBrand (brandName: string, brandLogo: RequestFile, backgroundColor?: string, buttonColor?: string, buttonTextColor?: string, emailDisplayName?: string, disclaimerDescription?: string, disclaimerTitle?: string, redirectUrl?: string, isDefault?: boolean, canHideTagLine?: boolean, combineAuditTrail?: boolean, combineAttachments?: boolean, excludeAuditTrailFromEmail?: boolean, emailSignedDocument?: string, documentTimeZone?: string, showBuiltInFormFields?: boolean, allowCustomFieldCreation?: boolean, showSharedCustomFields?: boolean, hideDecline?: boolean, hideSave?: boolean, documentExpirySettingsExpiryDateType?: string, documentExpirySettingsExpiryValue?: number, documentExpirySettingsEnableDefaultExpiryAlert?: boolean, documentExpirySettingsEnableAutoReminder?: boolean, documentExpirySettingsReminderDays?: number, documentExpirySettingsReminderCount?: number, customDomainSettingsDomainName?: string, customDomainSettingsFromName?: string, signatureFrameSettingsEnableSignatureFrame?: boolean, signatureFrameSettingsShowRecipientName?: boolean, signatureFrameSettingsShowRecipientEmail?: boolean, signatureFrameSettingsShowTimeStamp?: boolean, options: optionsI = {headers: {}}) : Promise<BrandCreated> {
|
|
238
242
|
const localVarPath = this.basePath + '/v1/brand/create';
|
|
239
243
|
let localVarQueryParameters: any = {};
|
|
240
244
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
@@ -379,6 +383,22 @@ export class BrandingApi {
|
|
|
379
383
|
localVarFormParams['CustomDomainSettings.FromName'] = ObjectSerializer.serialize(customDomainSettingsFromName, "string");
|
|
380
384
|
}
|
|
381
385
|
|
|
386
|
+
if (signatureFrameSettingsEnableSignatureFrame !== undefined) {
|
|
387
|
+
localVarFormParams['SignatureFrameSettings.EnableSignatureFrame'] = ObjectSerializer.serialize(signatureFrameSettingsEnableSignatureFrame, "boolean");
|
|
388
|
+
}
|
|
389
|
+
|
|
390
|
+
if (signatureFrameSettingsShowRecipientName !== undefined) {
|
|
391
|
+
localVarFormParams['SignatureFrameSettings.ShowRecipientName'] = ObjectSerializer.serialize(signatureFrameSettingsShowRecipientName, "boolean");
|
|
392
|
+
}
|
|
393
|
+
|
|
394
|
+
if (signatureFrameSettingsShowRecipientEmail !== undefined) {
|
|
395
|
+
localVarFormParams['SignatureFrameSettings.ShowRecipientEmail'] = ObjectSerializer.serialize(signatureFrameSettingsShowRecipientEmail, "boolean");
|
|
396
|
+
}
|
|
397
|
+
|
|
398
|
+
if (signatureFrameSettingsShowTimeStamp !== undefined) {
|
|
399
|
+
localVarFormParams['SignatureFrameSettings.ShowTimeStamp'] = ObjectSerializer.serialize(signatureFrameSettingsShowTimeStamp, "boolean");
|
|
400
|
+
}
|
|
401
|
+
|
|
382
402
|
let data = {};
|
|
383
403
|
if (localVarUseFormData) {
|
|
384
404
|
const formData = toFormData(localVarFormParams);
|
|
@@ -625,9 +645,13 @@ export class BrandingApi {
|
|
|
625
645
|
* @param documentExpirySettingsReminderCount
|
|
626
646
|
* @param customDomainSettingsDomainName
|
|
627
647
|
* @param customDomainSettingsFromName
|
|
648
|
+
* @param signatureFrameSettingsEnableSignatureFrame
|
|
649
|
+
* @param signatureFrameSettingsShowRecipientName
|
|
650
|
+
* @param signatureFrameSettingsShowRecipientEmail
|
|
651
|
+
* @param signatureFrameSettingsShowTimeStamp
|
|
628
652
|
* @param options
|
|
629
653
|
*/
|
|
630
|
-
public async editBrand (brandId: string, brandName?: string, brandLogo?: RequestFile, backgroundColor?: string, buttonColor?: string, buttonTextColor?: string, emailDisplayName?: string, disclaimerDescription?: string, disclaimerTitle?: string, redirectUrl?: string, isDefault?: boolean, canHideTagLine?: boolean, combineAuditTrail?: boolean, combineAttachments?: boolean, excludeAuditTrailFromEmail?: boolean, emailSignedDocument?: string, documentTimeZone?: string, showBuiltInFormFields?: boolean, allowCustomFieldCreation?: boolean, showSharedCustomFields?: boolean, hideDecline?: boolean, hideSave?: boolean, documentExpirySettingsExpiryDateType?: string, documentExpirySettingsExpiryValue?: number, documentExpirySettingsEnableDefaultExpiryAlert?: boolean, documentExpirySettingsEnableAutoReminder?: boolean, documentExpirySettingsReminderDays?: number, documentExpirySettingsReminderCount?: number, customDomainSettingsDomainName?: string, customDomainSettingsFromName?: string, options: optionsI = {headers: {}}) : Promise<BrandCreated> {
|
|
654
|
+
public async editBrand (brandId: string, brandName?: string, brandLogo?: RequestFile, backgroundColor?: string, buttonColor?: string, buttonTextColor?: string, emailDisplayName?: string, disclaimerDescription?: string, disclaimerTitle?: string, redirectUrl?: string, isDefault?: boolean, canHideTagLine?: boolean, combineAuditTrail?: boolean, combineAttachments?: boolean, excludeAuditTrailFromEmail?: boolean, emailSignedDocument?: string, documentTimeZone?: string, showBuiltInFormFields?: boolean, allowCustomFieldCreation?: boolean, showSharedCustomFields?: boolean, hideDecline?: boolean, hideSave?: boolean, documentExpirySettingsExpiryDateType?: string, documentExpirySettingsExpiryValue?: number, documentExpirySettingsEnableDefaultExpiryAlert?: boolean, documentExpirySettingsEnableAutoReminder?: boolean, documentExpirySettingsReminderDays?: number, documentExpirySettingsReminderCount?: number, customDomainSettingsDomainName?: string, customDomainSettingsFromName?: string, signatureFrameSettingsEnableSignatureFrame?: boolean, signatureFrameSettingsShowRecipientName?: boolean, signatureFrameSettingsShowRecipientEmail?: boolean, signatureFrameSettingsShowTimeStamp?: boolean, options: optionsI = {headers: {}}) : Promise<BrandCreated> {
|
|
631
655
|
const localVarPath = this.basePath + '/v1/brand/edit';
|
|
632
656
|
let localVarQueryParameters: any = {};
|
|
633
657
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
@@ -771,6 +795,22 @@ export class BrandingApi {
|
|
|
771
795
|
localVarFormParams['CustomDomainSettings.FromName'] = ObjectSerializer.serialize(customDomainSettingsFromName, "string");
|
|
772
796
|
}
|
|
773
797
|
|
|
798
|
+
if (signatureFrameSettingsEnableSignatureFrame !== undefined) {
|
|
799
|
+
localVarFormParams['SignatureFrameSettings.EnableSignatureFrame'] = ObjectSerializer.serialize(signatureFrameSettingsEnableSignatureFrame, "boolean");
|
|
800
|
+
}
|
|
801
|
+
|
|
802
|
+
if (signatureFrameSettingsShowRecipientName !== undefined) {
|
|
803
|
+
localVarFormParams['SignatureFrameSettings.ShowRecipientName'] = ObjectSerializer.serialize(signatureFrameSettingsShowRecipientName, "boolean");
|
|
804
|
+
}
|
|
805
|
+
|
|
806
|
+
if (signatureFrameSettingsShowRecipientEmail !== undefined) {
|
|
807
|
+
localVarFormParams['SignatureFrameSettings.ShowRecipientEmail'] = ObjectSerializer.serialize(signatureFrameSettingsShowRecipientEmail, "boolean");
|
|
808
|
+
}
|
|
809
|
+
|
|
810
|
+
if (signatureFrameSettingsShowTimeStamp !== undefined) {
|
|
811
|
+
localVarFormParams['SignatureFrameSettings.ShowTimeStamp'] = ObjectSerializer.serialize(signatureFrameSettingsShowTimeStamp, "boolean");
|
|
812
|
+
}
|
|
813
|
+
|
|
774
814
|
let data = {};
|
|
775
815
|
if (localVarUseFormData) {
|
|
776
816
|
const formData = toFormData(localVarFormParams);
|
package/api/documentApi.ts
CHANGED
|
@@ -492,122 +492,6 @@ export class DocumentApi {
|
|
|
492
492
|
}
|
|
493
493
|
|
|
494
494
|
|
|
495
|
-
reject(error);
|
|
496
|
-
});
|
|
497
|
-
});
|
|
498
|
-
});
|
|
499
|
-
}
|
|
500
|
-
/**
|
|
501
|
-
*
|
|
502
|
-
* @summary Cancels editing for a document that is currently in edit-mode.
|
|
503
|
-
* @param documentId The document id.
|
|
504
|
-
* @param onBehalfOf The onbehalfof email id.
|
|
505
|
-
* @param options
|
|
506
|
-
*/
|
|
507
|
-
public async cancelEditing (documentId: string, onBehalfOf?: string, options: optionsI = {headers: {}}) : Promise<returnTypeI> {
|
|
508
|
-
const localVarPath = this.basePath + '/v1-beta/document/cancelEditing';
|
|
509
|
-
let localVarQueryParameters: any = {};
|
|
510
|
-
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
511
|
-
const produces = ['application/json'];
|
|
512
|
-
// give precedence to 'application/json'
|
|
513
|
-
if (produces.indexOf('application/json') >= 0) {
|
|
514
|
-
localVarHeaderParams['content-type'] = 'application/json';
|
|
515
|
-
} else {
|
|
516
|
-
localVarHeaderParams['content-type'] = produces.join(',');
|
|
517
|
-
}
|
|
518
|
-
let localVarFormParams: any = {};
|
|
519
|
-
let localVarBodyParams: any = undefined;
|
|
520
|
-
|
|
521
|
-
// verify required parameter 'documentId' is not null or undefined
|
|
522
|
-
if (documentId === null || documentId === undefined) {
|
|
523
|
-
throw new Error('Required parameter documentId was null or undefined when calling cancelEditing.');
|
|
524
|
-
}
|
|
525
|
-
|
|
526
|
-
if (documentId !== undefined) {
|
|
527
|
-
localVarQueryParameters['documentId'] = ObjectSerializer.serialize(documentId, "string");
|
|
528
|
-
}
|
|
529
|
-
|
|
530
|
-
if (onBehalfOf !== undefined) {
|
|
531
|
-
localVarQueryParameters['onBehalfOf'] = ObjectSerializer.serialize(onBehalfOf, "string");
|
|
532
|
-
}
|
|
533
|
-
|
|
534
|
-
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|
535
|
-
|
|
536
|
-
let localVarUseFormData = false;
|
|
537
|
-
|
|
538
|
-
let data = {};
|
|
539
|
-
if (localVarUseFormData) {
|
|
540
|
-
const formData = toFormData(localVarFormParams);
|
|
541
|
-
data = formData;
|
|
542
|
-
localVarHeaderParams = {
|
|
543
|
-
...localVarHeaderParams,
|
|
544
|
-
...formData.getHeaders(),
|
|
545
|
-
};
|
|
546
|
-
}
|
|
547
|
-
|
|
548
|
-
let localVarRequestOptions: AxiosRequestConfig = {
|
|
549
|
-
method: 'POST',
|
|
550
|
-
params: localVarQueryParameters,
|
|
551
|
-
headers: localVarHeaderParams,
|
|
552
|
-
url: localVarPath,
|
|
553
|
-
paramsSerializer: this._useQuerystring ? queryParamsSerializer : undefined,
|
|
554
|
-
maxContentLength: Infinity,
|
|
555
|
-
maxBodyLength: Infinity,
|
|
556
|
-
responseType: "json",
|
|
557
|
-
};
|
|
558
|
-
|
|
559
|
-
if (localVarRequestOptions.method !== 'GET') {
|
|
560
|
-
localVarRequestOptions.data = data;
|
|
561
|
-
}
|
|
562
|
-
let authenticationPromise = Promise.resolve();
|
|
563
|
-
|
|
564
|
-
if (this.authentications["X-API-KEY"].apiKey) {
|
|
565
|
-
authenticationPromise = authenticationPromise.then(() => this.authentications["X-API-KEY"].applyToRequest(localVarRequestOptions));
|
|
566
|
-
}
|
|
567
|
-
if (this.authentications["Bearer"].apiKey) {
|
|
568
|
-
authenticationPromise = authenticationPromise.then(() => this.authentications["Bearer"].applyToRequest(localVarRequestOptions));
|
|
569
|
-
}
|
|
570
|
-
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
|
571
|
-
|
|
572
|
-
let interceptorPromise = authenticationPromise;
|
|
573
|
-
for (const interceptor of this.interceptors) {
|
|
574
|
-
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
|
575
|
-
}
|
|
576
|
-
|
|
577
|
-
return interceptorPromise.then(() => {
|
|
578
|
-
return new Promise<returnTypeI>((resolve, reject) => {
|
|
579
|
-
axios.request(localVarRequestOptions)
|
|
580
|
-
.then((response) => {
|
|
581
|
-
handleSuccessfulResponse(
|
|
582
|
-
resolve,
|
|
583
|
-
reject,
|
|
584
|
-
response,
|
|
585
|
-
|
|
586
|
-
);
|
|
587
|
-
}, (error: AxiosError) => {
|
|
588
|
-
if (error.response == null) {
|
|
589
|
-
reject(error);
|
|
590
|
-
return;
|
|
591
|
-
}
|
|
592
|
-
|
|
593
|
-
if (handleErrorCodeResponse(
|
|
594
|
-
reject,
|
|
595
|
-
error.response,
|
|
596
|
-
400,
|
|
597
|
-
"ErrorResult",
|
|
598
|
-
)) {
|
|
599
|
-
return;
|
|
600
|
-
}
|
|
601
|
-
if (handleErrorCodeResponse(
|
|
602
|
-
reject,
|
|
603
|
-
error.response,
|
|
604
|
-
401,
|
|
605
|
-
"ErrorResult",
|
|
606
|
-
)) {
|
|
607
|
-
return;
|
|
608
|
-
}
|
|
609
|
-
|
|
610
|
-
|
|
611
495
|
reject(error);
|
|
612
496
|
});
|
|
613
497
|
});
|
|
@@ -884,7 +768,7 @@ export class DocumentApi {
|
|
|
884
768
|
*/
|
|
885
769
|
public async createEmbeddedEditUrl (documentId: string, embeddedDocumentEditJsonRequest?: EmbeddedDocumentEditJsonRequest, options: optionsI = {headers: {}}) : Promise<EmbeddedDocumentEdited> {
|
|
886
770
|
embeddedDocumentEditJsonRequest = deserializeIfNeeded(embeddedDocumentEditJsonRequest, "EmbeddedDocumentEditJsonRequest");
|
|
887
|
-
const localVarPath = this.basePath + '/v1
|
|
771
|
+
const localVarPath = this.basePath + '/v1/document/createEmbeddedEditUrl';
|
|
888
772
|
let localVarQueryParameters: any = {};
|
|
889
773
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
890
774
|
const produces = ['application/json'];
|
|
@@ -1771,7 +1655,7 @@ export class DocumentApi {
|
|
|
1771
1655
|
* @param options
|
|
1772
1656
|
*/
|
|
1773
1657
|
public async draftSend (documentId: string, options: optionsI = {headers: {}}) : Promise<returnTypeI> {
|
|
1774
|
-
const localVarPath = this.basePath + '/v1
|
|
1658
|
+
const localVarPath = this.basePath + '/v1/document/draftSend';
|
|
1775
1659
|
let localVarQueryParameters: any = {};
|
|
1776
1660
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
1777
1661
|
const produces = ['application/json'];
|
|
@@ -1884,7 +1768,7 @@ export class DocumentApi {
|
|
|
1884
1768
|
*/
|
|
1885
1769
|
public async editDocument (documentId: string, editDocumentRequest?: EditDocumentRequest, options: optionsI = {headers: {}}) : Promise<DocumentEdited> {
|
|
1886
1770
|
editDocumentRequest = deserializeIfNeeded(editDocumentRequest, "EditDocumentRequest");
|
|
1887
|
-
const localVarPath = this.basePath + '/v1
|
|
1771
|
+
const localVarPath = this.basePath + '/v1/document/edit';
|
|
1888
1772
|
let localVarQueryParameters: any = {};
|
|
1889
1773
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
1890
1774
|
const produces = ['application/json'];
|
package/api/groupContactsApi.ts
CHANGED
|
@@ -99,7 +99,7 @@ export class GroupContactsApi {
|
|
|
99
99
|
*/
|
|
100
100
|
public async createGroupContact (groupContactDetails?: GroupContactDetails, options: optionsI = {headers: {}}) : Promise<CreateGroupContactResponse> {
|
|
101
101
|
groupContactDetails = deserializeIfNeeded(groupContactDetails, "GroupContactDetails");
|
|
102
|
-
const localVarPath = this.basePath + '/v1
|
|
102
|
+
const localVarPath = this.basePath + '/v1/contactGroups/create';
|
|
103
103
|
let localVarQueryParameters: any = {};
|
|
104
104
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
105
105
|
const produces = ['application/json'];
|
|
@@ -217,7 +217,7 @@ export class GroupContactsApi {
|
|
|
217
217
|
* @param options
|
|
218
218
|
*/
|
|
219
219
|
public async deleteGroupContact (groupId: string, options: optionsI = {headers: {}}) : Promise<returnTypeI> {
|
|
220
|
-
const localVarPath = this.basePath + '/v1
|
|
220
|
+
const localVarPath = this.basePath + '/v1/contactGroups/delete';
|
|
221
221
|
let localVarQueryParameters: any = {};
|
|
222
222
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
223
223
|
const produces = ['application/json'];
|
|
@@ -328,7 +328,7 @@ export class GroupContactsApi {
|
|
|
328
328
|
* @param options
|
|
329
329
|
*/
|
|
330
330
|
public async getGroupContact (groupId: string, options: optionsI = {headers: {}}) : Promise<GetGroupContactDetails> {
|
|
331
|
-
const localVarPath = this.basePath + '/v1
|
|
331
|
+
const localVarPath = this.basePath + '/v1/contactGroups/get';
|
|
332
332
|
let localVarQueryParameters: any = {};
|
|
333
333
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
334
334
|
const produces = ['application/json'];
|
|
@@ -451,7 +451,7 @@ export class GroupContactsApi {
|
|
|
451
451
|
* @param options
|
|
452
452
|
*/
|
|
453
453
|
public async groupContactList (page: number, pageSize?: number, searchKey?: string, contactType?: 'MyContacts' | 'AllContacts', directories?: Array<string>, options: optionsI = {headers: {}}) : Promise<GroupContactsList> {
|
|
454
|
-
const localVarPath = this.basePath + '/v1
|
|
454
|
+
const localVarPath = this.basePath + '/v1/contactGroups/list';
|
|
455
455
|
let localVarQueryParameters: any = {};
|
|
456
456
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
457
457
|
const produces = ['application/json'];
|
|
@@ -580,7 +580,7 @@ export class GroupContactsApi {
|
|
|
580
580
|
*/
|
|
581
581
|
public async updateGroupContact (groupId: string, updateGroupContact: UpdateGroupContact, options: optionsI = {headers: {}}) : Promise<returnTypeI> {
|
|
582
582
|
updateGroupContact = deserializeIfNeeded(updateGroupContact, "UpdateGroupContact");
|
|
583
|
-
const localVarPath = this.basePath + '/v1
|
|
583
|
+
const localVarPath = this.basePath + '/v1/contactGroups/update';
|
|
584
584
|
let localVarQueryParameters: any = {};
|
|
585
585
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
586
586
|
const produces = ['application/json'];
|