boldsign 3.0.2 → 3.1.0-beta.0

package/.openapi-generator/FILES

@@ -7,6 +7,7 @@ api/brandingApi.ts
 api/contactsApi.ts
 api/customFieldApi.ts
 api/documentApi.ts
+api/groupContactsApi.ts
 api/identityVerificationApi.ts
 api/index.ts
 api/planApi.ts
@@ -41,10 +42,12 @@ model/contactPageDetails.ts
 model/contactsDetails.ts
 model/contactsList.ts
 model/createContactResponse.ts
+model/createGroupContactResponse.ts
 model/createSenderIdentityRequest.ts
 model/createTeamRequest.ts
 model/createTemplateRequest.ts
 model/createUser.ts
+model/creators.ts
 model/customDomainSettings.ts
 model/customFieldCollection.ts
 model/customFieldMessage.ts
@@ -53,24 +56,36 @@ model/deleteCustomFieldReply.ts
 model/document.ts
 model/documentCC.ts
 model/documentCcDetails.ts
+model/documentCcWebhookModel.ts
 model/documentCreated.ts
+model/documentEdited.ts
+model/documentEvent.ts
 model/documentExpirySettings.ts
 model/documentFiles.ts
 model/documentFormFields.ts
+model/documentGroupSignerWebhookModel.ts
 model/documentInfo.ts
 model/documentProperties.ts
 model/documentReassign.ts
 model/documentRecords.ts
+model/documentSender.ts
 model/documentSenderDetail.ts
 model/documentSigner.ts
 model/documentSignerDetails.ts
+model/documentSignerWebhookModel.ts
 model/documentTags.ts
 model/downloadImageRequest.ts
+model/editDocumentFile.ts
+model/editDocumentRequest.ts
+model/editDocumentSigner.ts
+model/editFormField.ts
 model/editSenderIdentityRequest.ts
 model/editTemplateRequest.ts
 model/editableDateFieldSettings.ts
 model/embeddedCreateTemplateRequest.ts
 model/embeddedCustomFieldCreated.ts
+model/embeddedDocumentEditJsonRequest.ts
+model/embeddedDocumentEdited.ts
 model/embeddedDocumentRequest.ts
 model/embeddedFileDetails.ts
 model/embeddedFileLink.ts
@@ -83,6 +98,7 @@ model/embeddedTemplateEditRequest.ts
 model/embeddedTemplateEdited.ts
 model/embeddedTemplatePreview.ts
 model/embeddedTemplatePreviewJsonRequest.ts
+model/errorResponse.ts
 model/errorResult.ts
 model/existingFormField.ts
 model/extendExpiry.ts
@@ -92,12 +108,21 @@ model/formField.ts
 model/formFieldPermission.ts
 model/formGroup.ts
 model/formulaFieldSettings.ts
+model/getGroupContactDetails.ts
+model/groupContact.ts
+model/groupContactDetails.ts
+model/groupContactsList.ts
 model/groupSigner.ts
 model/groupSignerSettings.ts
+model/groupSignerSettingsWebhookModel.ts
+model/groupUser.ts
+model/iWebhookData.ts
 model/idDocument.ts
 model/idReport.ts
 model/idVerification.ts
 model/idVerificationDetails.ts
+model/idVerificationSignerWebhookModel.ts
+model/identityVerificationEvent.ts
 model/identityVerificationSettings.ts
 model/imageInfo.ts
 model/index.ts
@@ -109,6 +134,7 @@ model/modificationDetails.ts
 model/notificationSettings.ts
 model/pageDetails.ts
 model/phoneNumber.ts
+model/phoneNumberWebhookModel.ts
 model/prefillField.ts
 model/prefillFieldRequest.ts
 model/recipientChangeLog.ts
@@ -124,9 +150,12 @@ model/roles.ts
 model/sendForSign.ts
 model/sendForSignFromTemplateForm.ts
 model/senderIdentityCreated.ts
+model/senderIdentityCreator.ts
+model/senderIdentityEvent.ts
 model/senderIdentityList.ts
 model/senderIdentityViewModel.ts
 model/signerAuthenticationSettings.ts
+model/signerAuthenticationWebhookModel.ts
 model/size.ts
 model/teamCreated.ts
 model/teamDocumentRecords.ts
@@ -138,22 +167,30 @@ model/teamUsers.ts
 model/teams.ts
 model/template.ts
 model/templateCC.ts
+model/templateCcWebhookModel.ts
 model/templateCreated.ts
+model/templateEvent.ts
 model/templateFiles.ts
 model/templateFormFields.ts
-model/templateGroupSigner.ts
+model/templateGroupSignerWebhookModel.ts
 model/templateProperties.ts
 model/templateRecords.ts
 model/templateRole.ts
+model/templateSender.ts
 model/templateSenderDetail.ts
 model/templateSenderDetails.ts
+model/templateShareErrorResponse.ts
+model/templateShareRequest.ts
 model/templateSharedTemplateDetail.ts
 model/templateSharing.ts
+model/templateSigner.ts
 model/templateSignerDetails.ts
 model/templateTag.ts
 model/templateTeamShare.ts
+model/templateTeamShareRequest.ts
 model/textTagDefinition.ts
 model/textTagOffset.ts
+model/updateGroupContact.ts
 model/updateUser.ts
 model/updateUserMetaData.ts
 model/userPageDetails.ts
@@ -164,5 +201,8 @@ model/validation.ts
 model/verificationDataRequest.ts
 model/viewBrandDetails.ts
 model/viewCustomFieldDetails.ts
+model/webhookEvent.ts
+model/webhookEventData.ts
+model/webhookEventMetadata.ts
 package.json
 tsconfig.json

package/README.md

@@ -85,15 +85,18 @@ All URIs are relative to *https://api.boldsign.com*
 | *DocumentApi* | [**addAuthentication**](./docs/DocumentApi.md#addauthentication) | **PATCH** /v1/document/addAuthentication | The add authentication to recipient. |
 | *DocumentApi* | [**addTag**](./docs/DocumentApi.md#addtag) | **PATCH** /v1/document/addTags | Add the Tags in Documents. |
 | *DocumentApi* | [**behalfDocuments**](./docs/DocumentApi.md#behalfdocuments) | **GET** /v1/document/behalfList | Gets the behalf documents. |
+| *DocumentApi* | [**cancelEditing**](./docs/DocumentApi.md#cancelediting) | **POST** /v1-beta/document/cancelEditing | Cancels editing for a document that is currently in edit-mode. |
 | *DocumentApi* | [**changeAccessCode**](./docs/DocumentApi.md#changeaccesscode) | **PATCH** /v1/document/changeAccessCode | Changes the access code for the given document signer. |
 | *DocumentApi* | [**changeRecipient**](./docs/DocumentApi.md#changerecipient) | **PATCH** /v1/document/changeRecipient | Change recipient details of a document. |
+| *DocumentApi* | [**createEmbeddedEditUrl**](./docs/DocumentApi.md#createembeddedediturl) | **POST** /v1-beta/document/createEmbeddedEditUrl | Generates an embedded edit URL that allows the document editing process to be integrated into your application. |
 | *DocumentApi* | [**createEmbeddedRequestUrlDocument**](./docs/DocumentApi.md#createembeddedrequesturldocument) | **POST** /v1/document/createEmbeddedRequestUrl | Generates a send URL which embeds document sending process into your application. |
 | *DocumentApi* | [**deleteDocument**](./docs/DocumentApi.md#deletedocument) | **DELETE** /v1/document/delete | Delete the document. |
 | *DocumentApi* | [**deleteTag**](./docs/DocumentApi.md#deletetag) | **DELETE** /v1/document/deleteTags | Delete the Tags in Documents. |
 | *DocumentApi* | [**downloadAttachment**](./docs/DocumentApi.md#downloadattachment) | **GET** /v1/document/downloadAttachment | Download the Attachment. |
 | *DocumentApi* | [**downloadAuditLog**](./docs/DocumentApi.md#downloadauditlog) | **GET** /v1/document/downloadAuditLog | Download the audit trail document. |
 | *DocumentApi* | [**downloadDocument**](./docs/DocumentApi.md#downloaddocument) | **GET** /v1/document/download | Download the document. |
-| *DocumentApi* | [**draftSend**](./docs/DocumentApi.md#draftsend) | **POST** /v1/document/draftSend | Sends a draft-status document out for signature. |
+| *DocumentApi* | [**draftSend**](./docs/DocumentApi.md#draftsend) | **POST** /v1-beta/document/draftSend | Sends a draft-status document out for signature. |
+| *DocumentApi* | [**editDocument**](./docs/DocumentApi.md#editdocument) | **PUT** /v1-beta/document/edit | Edit and updates an existing document. |
 | *DocumentApi* | [**extendExpiry**](./docs/DocumentApi.md#extendexpiry) | **PATCH** /v1/document/extendExpiry | Extends the expiration date of the document. |
 | *DocumentApi* | [**getProperties**](./docs/DocumentApi.md#getproperties) | **GET** /v1/document/properties | Get summary of the document. |
 | *DocumentApi* | [**getEmbeddedSignLink**](./docs/DocumentApi.md#getembeddedsignlink) | **GET** /v1/document/getEmbeddedSignLink | Get sign link for Embedded Sign. |
@@ -104,6 +107,11 @@ All URIs are relative to *https://api.boldsign.com*
 | *DocumentApi* | [**revokeDocument**](./docs/DocumentApi.md#revokedocument) | **POST** /v1/document/revoke | Revoke the document. |
 | *DocumentApi* | [**sendDocument**](./docs/DocumentApi.md#senddocument) | **POST** /v1/document/send | Sends the document for sign. |
 | *DocumentApi* | [**teamDocuments**](./docs/DocumentApi.md#teamdocuments) | **GET** /v1/document/teamlist | Get user Team documents. |
+| *GroupContactsApi* | [**createGroupContact**](./docs/GroupContactsApi.md#creategroupcontact) | **POST** /v1-beta/contactGroups/create | Create a new Group Contact. |
+| *GroupContactsApi* | [**deleteGroupContact**](./docs/GroupContactsApi.md#deletegroupcontact) | **DELETE** /v1-beta/contactGroups/delete | Deletes a Group Contact. |
+| *GroupContactsApi* | [**getGroupContact**](./docs/GroupContactsApi.md#getgroupcontact) | **GET** /v1-beta/contactGroups/get | Get Summary of the Group Contact. |
+| *GroupContactsApi* | [**groupContactList**](./docs/GroupContactsApi.md#groupcontactlist) | **GET** /v1-beta/contactGroups/list | List Group Contacts. |
+| *GroupContactsApi* | [**updateGroupContact**](./docs/GroupContactsApi.md#updategroupcontact) | **PUT** /v1-beta/contactGroups/update | Update the Group Contact. |
 | *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. |
 | *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. |
 | *IdentityVerificationApi* | [**report**](./docs/IdentityVerificationApi.md#report) | **POST** /v1/identityVerification/report | Retrieve the ID verification report for the specified document signer. |
@@ -134,8 +142,9 @@ All URIs are relative to *https://api.boldsign.com*
 | *TemplateApi* | [**mergeAndSend**](./docs/TemplateApi.md#mergeandsend) | **POST** /v1/template/mergeAndSend | Send the document by merging multiple templates. |
 | *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. |
 | *TemplateApi* | [**sendUsingTemplate**](./docs/TemplateApi.md#sendusingtemplate) | **POST** /v1/template/send | Send a document for signature using a Template. |
+| *TemplateApi* | [**shareTemplate**](./docs/TemplateApi.md#sharetemplate) | **PATCH** /v1-beta/template/share | Share a template with teams and manage permissions. |
 | *UserApi* | [**cancelInvitation**](./docs/UserApi.md#cancelinvitation) | **POST** /v1/users/cancelInvitation | Cancel the users invitation. |
-| *UserApi* | [**changeTeam**](./docs/UserApi.md#changeteam) | **PUT** /v1/users/changeTeam | Change users to other team. |
+| *UserApi* | [**changeTeam**](./docs/UserApi.md#changeteam) | **PUT** /v1-beta/users/changeTeam | Change users to other team. |
 | *UserApi* | [**createUser**](./docs/UserApi.md#createuser) | **POST** /v1/users/create | Create the user. |
 | *UserApi* | [**getUser**](./docs/UserApi.md#getuser) | **GET** /v1/users/get | Get summary of the user. |
 | *UserApi* | [**listUsers**](./docs/UserApi.md#listusers) | **GET** /v1/users/list | List user documents. |
@@ -171,10 +180,12 @@ All URIs are relative to *https://api.boldsign.com*
 - [ContactsDetails](./docs/ContactsDetails.md)
 - [ContactsList](./docs/ContactsList.md)
 - [CreateContactResponse](./docs/CreateContactResponse.md)
+- [CreateGroupContactResponse](./docs/CreateGroupContactResponse.md)
 - [CreateSenderIdentityRequest](./docs/CreateSenderIdentityRequest.md)
 - [CreateTeamRequest](./docs/CreateTeamRequest.md)
 - [CreateTemplateRequest](./docs/CreateTemplateRequest.md)
 - [CreateUser](./docs/CreateUser.md)
+- [Creators](./docs/Creators.md)
 - [CustomDomainSettings](./docs/CustomDomainSettings.md)
 - [CustomFieldCollection](./docs/CustomFieldCollection.md)
 - [CustomFieldMessage](./docs/CustomFieldMessage.md)
@@ -183,24 +194,36 @@ All URIs are relative to *https://api.boldsign.com*
 - [Document](./docs/Document.md)
 - [DocumentCC](./docs/DocumentCC.md)
 - [DocumentCcDetails](./docs/DocumentCcDetails.md)
+- [DocumentCcWebhookModel](./docs/DocumentCcWebhookModel.md)
 - [DocumentCreated](./docs/DocumentCreated.md)
+- [DocumentEdited](./docs/DocumentEdited.md)
+- [DocumentEvent](./docs/DocumentEvent.md)
 - [DocumentExpirySettings](./docs/DocumentExpirySettings.md)
 - [DocumentFiles](./docs/DocumentFiles.md)
 - [DocumentFormFields](./docs/DocumentFormFields.md)
+- [DocumentGroupSignerWebhookModel](./docs/DocumentGroupSignerWebhookModel.md)
 - [DocumentInfo](./docs/DocumentInfo.md)
 - [DocumentProperties](./docs/DocumentProperties.md)
 - [DocumentReassign](./docs/DocumentReassign.md)
 - [DocumentRecords](./docs/DocumentRecords.md)
+- [DocumentSender](./docs/DocumentSender.md)
 - [DocumentSenderDetail](./docs/DocumentSenderDetail.md)
 - [DocumentSigner](./docs/DocumentSigner.md)
 - [DocumentSignerDetails](./docs/DocumentSignerDetails.md)
+- [DocumentSignerWebhookModel](./docs/DocumentSignerWebhookModel.md)
 - [DocumentTags](./docs/DocumentTags.md)
 - [DownloadImageRequest](./docs/DownloadImageRequest.md)
+- [EditDocumentFile](./docs/EditDocumentFile.md)
+- [EditDocumentRequest](./docs/EditDocumentRequest.md)
+- [EditDocumentSigner](./docs/EditDocumentSigner.md)
+- [EditFormField](./docs/EditFormField.md)
 - [EditSenderIdentityRequest](./docs/EditSenderIdentityRequest.md)
 - [EditTemplateRequest](./docs/EditTemplateRequest.md)
 - [EditableDateFieldSettings](./docs/EditableDateFieldSettings.md)
 - [EmbeddedCreateTemplateRequest](./docs/EmbeddedCreateTemplateRequest.md)
 - [EmbeddedCustomFieldCreated](./docs/EmbeddedCustomFieldCreated.md)
+- [EmbeddedDocumentEditJsonRequest](./docs/EmbeddedDocumentEditJsonRequest.md)
+- [EmbeddedDocumentEdited](./docs/EmbeddedDocumentEdited.md)
 - [EmbeddedDocumentRequest](./docs/EmbeddedDocumentRequest.md)
 - [EmbeddedFileDetails](./docs/EmbeddedFileDetails.md)
 - [EmbeddedFileLink](./docs/EmbeddedFileLink.md)
@@ -213,6 +236,7 @@ All URIs are relative to *https://api.boldsign.com*
 - [EmbeddedTemplateEdited](./docs/EmbeddedTemplateEdited.md)
 - [EmbeddedTemplatePreview](./docs/EmbeddedTemplatePreview.md)
 - [EmbeddedTemplatePreviewJsonRequest](./docs/EmbeddedTemplatePreviewJsonRequest.md)
+- [ErrorResponse](./docs/ErrorResponse.md)
 - [ErrorResult](./docs/ErrorResult.md)
 - [ExistingFormField](./docs/ExistingFormField.md)
 - [ExtendExpiry](./docs/ExtendExpiry.md)
@@ -222,12 +246,21 @@ All URIs are relative to *https://api.boldsign.com*
 - [FormFieldPermission](./docs/FormFieldPermission.md)
 - [FormGroup](./docs/FormGroup.md)
 - [FormulaFieldSettings](./docs/FormulaFieldSettings.md)
+- [GetGroupContactDetails](./docs/GetGroupContactDetails.md)
+- [GroupContact](./docs/GroupContact.md)
+- [GroupContactDetails](./docs/GroupContactDetails.md)
+- [GroupContactsList](./docs/GroupContactsList.md)
 - [GroupSigner](./docs/GroupSigner.md)
 - [GroupSignerSettings](./docs/GroupSignerSettings.md)
+- [GroupSignerSettingsWebhookModel](./docs/GroupSignerSettingsWebhookModel.md)
+- [GroupUser](./docs/GroupUser.md)
+- [IWebhookData](./docs/IWebhookData.md)
 - [IdDocument](./docs/IdDocument.md)
 - [IdReport](./docs/IdReport.md)
 - [IdVerification](./docs/IdVerification.md)
 - [IdVerificationDetails](./docs/IdVerificationDetails.md)
+- [IdVerificationSignerWebhookModel](./docs/IdVerificationSignerWebhookModel.md)
+- [IdentityVerificationEvent](./docs/IdentityVerificationEvent.md)
 - [IdentityVerificationSettings](./docs/IdentityVerificationSettings.md)
 - [ImageInfo](./docs/ImageInfo.md)
 - [MergeAndSendForSignForm](./docs/MergeAndSendForSignForm.md)
@@ -237,6 +270,7 @@ All URIs are relative to *https://api.boldsign.com*
 - [NotificationSettings](./docs/NotificationSettings.md)
 - [PageDetails](./docs/PageDetails.md)
 - [PhoneNumber](./docs/PhoneNumber.md)
+- [PhoneNumberWebhookModel](./docs/PhoneNumberWebhookModel.md)
 - [PrefillField](./docs/PrefillField.md)
 - [PrefillFieldRequest](./docs/PrefillFieldRequest.md)
 - [RecipientChangeLog](./docs/RecipientChangeLog.md)
@@ -252,9 +286,12 @@ All URIs are relative to *https://api.boldsign.com*
 - [SendForSign](./docs/SendForSign.md)
 - [SendForSignFromTemplateForm](./docs/SendForSignFromTemplateForm.md)
 - [SenderIdentityCreated](./docs/SenderIdentityCreated.md)
+- [SenderIdentityCreator](./docs/SenderIdentityCreator.md)
+- [SenderIdentityEvent](./docs/SenderIdentityEvent.md)
 - [SenderIdentityList](./docs/SenderIdentityList.md)
 - [SenderIdentityViewModel](./docs/SenderIdentityViewModel.md)
 - [SignerAuthenticationSettings](./docs/SignerAuthenticationSettings.md)
+- [SignerAuthenticationWebhookModel](./docs/SignerAuthenticationWebhookModel.md)
 - [Size](./docs/Size.md)
 - [TeamCreated](./docs/TeamCreated.md)
 - [TeamDocumentRecords](./docs/TeamDocumentRecords.md)
@@ -266,22 +303,30 @@ All URIs are relative to *https://api.boldsign.com*
 - [Teams](./docs/Teams.md)
 - [Template](./docs/Template.md)
 - [TemplateCC](./docs/TemplateCC.md)
+- [TemplateCcWebhookModel](./docs/TemplateCcWebhookModel.md)
 - [TemplateCreated](./docs/TemplateCreated.md)
+- [TemplateEvent](./docs/TemplateEvent.md)
 - [TemplateFiles](./docs/TemplateFiles.md)
 - [TemplateFormFields](./docs/TemplateFormFields.md)
-- [TemplateGroupSigner](./docs/TemplateGroupSigner.md)
+- [TemplateGroupSignerWebhookModel](./docs/TemplateGroupSignerWebhookModel.md)
 - [TemplateProperties](./docs/TemplateProperties.md)
 - [TemplateRecords](./docs/TemplateRecords.md)
 - [TemplateRole](./docs/TemplateRole.md)
+- [TemplateSender](./docs/TemplateSender.md)
 - [TemplateSenderDetail](./docs/TemplateSenderDetail.md)
 - [TemplateSenderDetails](./docs/TemplateSenderDetails.md)
+- [TemplateShareErrorResponse](./docs/TemplateShareErrorResponse.md)
+- [TemplateShareRequest](./docs/TemplateShareRequest.md)
 - [TemplateSharedTemplateDetail](./docs/TemplateSharedTemplateDetail.md)
 - [TemplateSharing](./docs/TemplateSharing.md)
+- [TemplateSigner](./docs/TemplateSigner.md)
 - [TemplateSignerDetails](./docs/TemplateSignerDetails.md)
 - [TemplateTag](./docs/TemplateTag.md)
 - [TemplateTeamShare](./docs/TemplateTeamShare.md)
+- [TemplateTeamShareRequest](./docs/TemplateTeamShareRequest.md)
 - [TextTagDefinition](./docs/TextTagDefinition.md)
 - [TextTagOffset](./docs/TextTagOffset.md)
+- [UpdateGroupContact](./docs/UpdateGroupContact.md)
 - [UpdateUser](./docs/UpdateUser.md)
 - [UpdateUserMetaData](./docs/UpdateUserMetaData.md)
 - [UserPageDetails](./docs/UserPageDetails.md)
@@ -292,6 +337,9 @@ All URIs are relative to *https://api.boldsign.com*
 - [VerificationDataRequest](./docs/VerificationDataRequest.md)
 - [ViewBrandDetails](./docs/ViewBrandDetails.md)
 - [ViewCustomFieldDetails](./docs/ViewCustomFieldDetails.md)
+- [WebhookEvent](./docs/WebhookEvent.md)
+- [WebhookEventData](./docs/WebhookEventData.md)
+- [WebhookEventMetadata](./docs/WebhookEventMetadata.md)
 
 ## Authorization
 

package/api/apis.ts

@@ -24,7 +24,7 @@ export const queryParamsSerializer = (params) => {
     return Qs.stringify(params, { arrayFormat: 'repeat' })
 }
 
-export const USER_AGENT = "boldsign-node-sdk/3.0.2";
+export const USER_AGENT = "boldsign-node-sdk/3.1.0-beta.0";
 
 /**
  * Generates an object containing form data.
@@ -92,6 +92,19 @@ export const generateFormData = (
       return;
     }
 
+    if (paramInfo.type.includes('Array') && paramInfo.type.includes('EditDocumentFile')) {
+      obj[paramInfo.name].forEach((childObject, i) => {
+        Object.entries(childObject).forEach(([property, value]) => {
+          const key = `${paramInfo.baseName}[${i}].${property}`;
+          if(property == "file"){
+            localVarUseFormData = true;
+          }
+          data[key] = value;
+        });
+      });
+      return;
+    }
+
     if(paramInfo.type.indexOf("Array") !== -1) {
       const serializedArray: string[] = [];
       obj[paramInfo.name].forEach((childObject, i) => {
@@ -120,7 +133,7 @@ export const generateFormData = (
       });
       return;
     }
-    
+
     /**
      * Everything else that is not binary data (file uploads) can be
      * serialized to JSON and sent over. This helps reduce complexity