boldsign 3.1.0 → 3.1.2

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
@@ -76,6 +79,8 @@ 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
@@ -97,8 +102,13 @@ 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/groupUser.ts
 model/idDocument.ts
 model/idReport.ts
 model/idVerificationDetails.ts
@@ -159,6 +169,7 @@ model/templateTag.ts
 model/templateTeamShare.ts
 model/textTagDefinition.ts
 model/textTagOffset.ts
+model/updateGroupContact.ts
 model/updateUser.ts
 model/updateUserMetaData.ts
 model/userPageDetails.ts

package/README.md

@@ -85,8 +85,10 @@ 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/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/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. |
@@ -105,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/contactGroups/create | Create a new Group Contact. |
+| *GroupContactsApi* | [**deleteGroupContact**](./docs/GroupContactsApi.md#deletegroupcontact) | **DELETE** /v1/contactGroups/delete | Deletes a Group Contact. |
+| *GroupContactsApi* | [**getGroupContact**](./docs/GroupContactsApi.md#getgroupcontact) | **GET** /v1/contactGroups/get | Get Summary of the Group Contact. |
+| *GroupContactsApi* | [**groupContactList**](./docs/GroupContactsApi.md#groupcontactlist) | **GET** /v1/contactGroups/list | List Group Contacts. |
+| *GroupContactsApi* | [**updateGroupContact**](./docs/GroupContactsApi.md#updategroupcontact) | **PUT** /v1/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. |
@@ -172,10 +179,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)
@@ -207,6 +216,8 @@ All URIs are relative to *https://api.boldsign.com*
 - [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)
@@ -228,8 +239,13 @@ 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)
+- [GroupUser](./docs/GroupUser.md)
 - [IdDocument](./docs/IdDocument.md)
 - [IdReport](./docs/IdReport.md)
 - [IdVerificationDetails](./docs/IdVerificationDetails.md)
@@ -288,6 +304,7 @@ All URIs are relative to *https://api.boldsign.com*
 - [TemplateTeamShare](./docs/TemplateTeamShare.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)

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.1.0";
+export const USER_AGENT = "boldsign-node-sdk/3.1.2";
 
 /**
  * Generates an object containing form data.

package/api/documentApi.ts

@@ -15,7 +15,7 @@ import axios, { AxiosError, AxiosRequestConfig, AxiosResponse } from 'axios';
 import {
     ObjectSerializer, Authentication, VoidAuth, Interceptor,
     HttpBasicAuth, HttpBearerAuth, ApiKeyAuth, OAuth, RequestFile, 
-    AccessCodeDetail,AccessCodeDetails,BehalfDocumentRecords,ChangeRecipient,DocumentCreated,DocumentEdited,DocumentProperties,DocumentRecords,DocumentTags,EditDocumentRequest,EmbeddedDocumentRequest,EmbeddedSendCreated,EmbeddedSigningLink,ErrorResult,ExtendExpiry,PrefillFieldRequest,ReminderMessage,RemoveAuthentication,RevokeDocument,SendForSign,TeamDocumentRecords,
+    AccessCodeDetail,AccessCodeDetails,BehalfDocumentRecords,ChangeRecipient,DocumentCreated,DocumentEdited,DocumentProperties,DocumentRecords,DocumentTags,EditDocumentRequest,EmbeddedDocumentEditJsonRequest,EmbeddedDocumentEdited,EmbeddedDocumentRequest,EmbeddedSendCreated,EmbeddedSigningLink,ErrorResult,ExtendExpiry,PrefillFieldRequest,ReminderMessage,RemoveAuthentication,RevokeDocument,SendForSign,TeamDocumentRecords,
 } from '../model';
 
 import {
@@ -492,6 +492,122 @@ export class DocumentApi {
                         }
 
 
+                        reject(error);
+                    });
+            });
+        });
+    }
+    /**
+     * 
+     * @summary Cancels editing for a document that is currently in edit-mode.
+     * @param documentId The document id.
+     * @param onBehalfOf The onbehalfof email id.
+     * @param options
+     */
+    public async cancelEditing (documentId: string, onBehalfOf?: string, options: optionsI = {headers: {}}) : Promise<returnTypeI> {
+        const localVarPath = this.basePath + '/v1/document/cancelEditing';
+        let localVarQueryParameters: any = {};
+        let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
+        const produces = ['application/json'];
+        // give precedence to 'application/json'
+        if (produces.indexOf('application/json') >= 0) {
+            localVarHeaderParams['content-type'] = 'application/json';
+        } else {
+            localVarHeaderParams['content-type'] = produces.join(',');
+        }
+        let localVarFormParams: any = {};
+        let localVarBodyParams: any = undefined;
+
+        // verify required parameter 'documentId' is not null or undefined
+        if (documentId === null || documentId === undefined) {
+            throw new Error('Required parameter documentId was null or undefined when calling cancelEditing.');
+        }
+
+        if (documentId !== undefined) {
+            localVarQueryParameters['documentId'] = ObjectSerializer.serialize(documentId, "string");
+        }
+
+        if (onBehalfOf !== undefined) {
+            localVarQueryParameters['onBehalfOf'] = ObjectSerializer.serialize(onBehalfOf, "string");
+        }
+
+        (<any>Object).assign(localVarHeaderParams, options.headers);
+
+        let localVarUseFormData = false;
+
+        let data = {};
+        if (localVarUseFormData) {
+          const formData = toFormData(localVarFormParams);
+          data = formData;
+          localVarHeaderParams = {
+            ...localVarHeaderParams,
+            ...formData.getHeaders(),
+          };
+        }
+
+        let localVarRequestOptions: AxiosRequestConfig = {
+            method: 'POST',
+            params: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            url: localVarPath,
+            paramsSerializer: this._useQuerystring ? queryParamsSerializer : undefined,
+            maxContentLength: Infinity,
+            maxBodyLength: Infinity,
+            responseType: "json",
+        };
+
+        if (localVarRequestOptions.method !== 'GET') {
+           localVarRequestOptions.data = data;
+        }
+        let authenticationPromise = Promise.resolve();
+
+        if (this.authentications["X-API-KEY"].apiKey) {
+            authenticationPromise = authenticationPromise.then(() => this.authentications["X-API-KEY"].applyToRequest(localVarRequestOptions));
+        }
+        if (this.authentications["Bearer"].apiKey) {
+            authenticationPromise = authenticationPromise.then(() => this.authentications["Bearer"].applyToRequest(localVarRequestOptions));
+        }
+        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
+
+        let interceptorPromise = authenticationPromise;
+        for (const interceptor of this.interceptors) {
+            interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
+        }
+
+        return interceptorPromise.then(() => {
+            return new Promise<returnTypeI>((resolve, reject) => {
+                axios.request(localVarRequestOptions)
+                    .then((response) => {
+                        handleSuccessfulResponse(
+                          resolve,
+                          reject,
+                          response,
+                          
+                        );
+                    }, (error: AxiosError) => {
+                        if (error.response == null) {
+                            reject(error);
+                            return;
+                        }
+
+                        if (handleErrorCodeResponse(
+                            reject,
+                            error.response,
+                            400,
+                            "ErrorResult",
+                        )) {
+                          return;
+                        }
+                        if (handleErrorCodeResponse(
+                            reject,
+                            error.response,
+                            401,
+                            "ErrorResult",
+                        )) {
+                          return;
+                        }
+
+
                         reject(error);
                     });
             });
@@ -754,6 +870,151 @@ export class DocumentApi {
                         }
 
 
+                        reject(error);
+                    });
+            });
+        });
+    }
+    /**
+     * 
+     * @summary Generates an embedded edit URL that allows the document editing process to be integrated into your application.
+     * @param documentId The document id.
+     * @param embeddedDocumentEditJsonRequest The embedded edit document request body.
+     * @param options
+     */
+    public async createEmbeddedEditUrl (documentId: string, embeddedDocumentEditJsonRequest?: EmbeddedDocumentEditJsonRequest, options: optionsI = {headers: {}}) : Promise<EmbeddedDocumentEdited> {
+        embeddedDocumentEditJsonRequest = deserializeIfNeeded(embeddedDocumentEditJsonRequest, "EmbeddedDocumentEditJsonRequest");
+        const localVarPath = this.basePath + '/v1/document/createEmbeddedEditUrl';
+        let localVarQueryParameters: any = {};
+        let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
+        const produces = ['application/json'];
+        // give precedence to 'application/json'
+        if (produces.indexOf('application/json') >= 0) {
+            localVarHeaderParams['content-type'] = 'application/json';
+        } else {
+            localVarHeaderParams['content-type'] = produces.join(',');
+        }
+        let localVarFormParams: any = {};
+        let localVarBodyParams: any = undefined;
+
+        // verify required parameter 'documentId' is not null or undefined
+        if (documentId === null || documentId === undefined) {
+            throw new Error('Required parameter documentId was null or undefined when calling createEmbeddedEditUrl.');
+        }
+
+        if (documentId !== undefined) {
+            localVarQueryParameters['documentId'] = ObjectSerializer.serialize(documentId, "string");
+        }
+
+        (<any>Object).assign(localVarHeaderParams, options.headers);
+
+        let localVarUseFormData = false;
+
+        const result = generateFormData(embeddedDocumentEditJsonRequest, EmbeddedDocumentEditJsonRequest);
+        localVarUseFormData = result.localVarUseFormData;
+
+        let data = {};
+        if (localVarUseFormData) {
+          const formData = toFormData(result.data);
+          data = formData;
+          localVarHeaderParams = {
+            ...localVarHeaderParams,
+            ...formData.getHeaders(),
+          };
+        } else {
+          data = ObjectSerializer.serialize(
+            embeddedDocumentEditJsonRequest,
+            "EmbeddedDocumentEditJsonRequest"
+          );
+        }
+
+        let localVarRequestOptions: AxiosRequestConfig = {
+            method: 'POST',
+            params: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            url: localVarPath,
+            paramsSerializer: this._useQuerystring ? queryParamsSerializer : undefined,
+            maxContentLength: Infinity,
+            maxBodyLength: Infinity,
+            responseType: "json",
+        };
+
+        if (localVarRequestOptions.method !== 'GET') {
+           localVarRequestOptions.data = data;
+        }
+        let authenticationPromise = Promise.resolve();
+
+        if (this.authentications["X-API-KEY"].apiKey) {
+            authenticationPromise = authenticationPromise.then(() => this.authentications["X-API-KEY"].applyToRequest(localVarRequestOptions));
+        }
+        if (this.authentications["Bearer"].apiKey) {
+            authenticationPromise = authenticationPromise.then(() => this.authentications["Bearer"].applyToRequest(localVarRequestOptions));
+        }
+        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
+
+        let interceptorPromise = authenticationPromise;
+        for (const interceptor of this.interceptors) {
+            interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
+        }
+
+        return interceptorPromise.then(() => {
+            return new Promise<EmbeddedDocumentEdited>((resolve, reject) => {
+                axios.request(localVarRequestOptions)
+                    .then((response) => {
+                        handleSuccessfulResponse<EmbeddedDocumentEdited>(
+                          resolve,
+                          reject,
+                          response,
+                          "EmbeddedDocumentEdited",
+                        );
+                    }, (error: AxiosError) => {
+                        if (error.response == null) {
+                            reject(error);
+                            return;
+                        }
+
+                        if (handleErrorCodeResponse(
+                            reject,
+                            error.response,
+                            201,
+                            "EmbeddedDocumentEdited",
+                        )) {
+                          return;
+                        }
+                        if (handleErrorCodeResponse(
+                            reject,
+                            error.response,
+                            400,
+                            "ErrorResult",
+                        )) {
+                          return;
+                        }
+                        if (handleErrorCodeResponse(
+                            reject,
+                            error.response,
+                            401,
+                            "ErrorResult",
+                        )) {
+                          return;
+                        }
+                        if (handleErrorCodeResponse(
+                            reject,
+                            error.response,
+                            403,
+                            "ErrorResult",
+                        )) {
+                          return;
+                        }
+                        if (handleErrorCodeResponse(
+                            reject,
+                            error.response,
+                            422,
+                            "ErrorResult",
+                        )) {
+                          return;
+                        }
+
+
                         reject(error);
                     });
             });