Auto Generated documentation

AntApi Module

class groupdocs.AntApi.AntApi(apiClient)[source]

Bases: object

AddAnnotationCollaborator(userId, fileId, **kwargs)[source]

Add an annotation collaborator

Args:
userId, str: User GUID (required) fileId, str: File ID (required) body, ReviewerInfo: Reviewer Info (optional)

Returns: AddCollaboratorResponse

CreateAnnotation(userId, fileId, body, **kwargs)[source]

Create annotation

Args:
userId, str: User GUID (required) fileId, str: File ID (required) body, AnnotationInfo: annotation (required)

Returns: CreateAnnotationResponse

CreateAnnotationReply(userId, annotationId, body, **kwargs)[source]

Create annotation reply

Args:
userId, str: User GUID (required) annotationId, str: Annotation ID (required) body, AnnotationReplyInfo: Reply (required)

Returns: AddReplyResponse

DeleteAnnotation(userId, annotationId, **kwargs)[source]

Delete annotation

Args:
userId, str: User GUID (required) annotationId, str: Annotation ID (required)

Returns: DeleteAnnotationResponse

DeleteAnnotationReply(userId, replyGuid, **kwargs)[source]

Delete annotation reply

Args:
userId, str: User GUID (required) replyGuid, str: Reply GUID (required)

Returns: DeleteReplyResponse

DeleteDocumentAnnotations(userId, fileId, **kwargs)[source]

Delete document annotations

Args:
userId, str: User GUID (required) fileId, str: File ID (required)

Returns: DeleteDocumentAnnotationsResponse

DeleteDocumentReviewer(userId, fileId, reviewerId, **kwargs)[source]

Delete document reviewer

Args:
userId, str: User GUID (required) fileId, str: File ID (required) reviewerId, str: Reviewer ID (required)

Returns: AddCollaboratorResponse

EditAnnotationReply(userId, replyGuid, body, **kwargs)[source]

Edit annotation reply

Args:
userId, str: User GUID (required) replyGuid, str: Reply GUID (required) body, str: Message (required)

Returns: EditReplyResponse

GetAnnotationCollaborators(userId, fileId, **kwargs)[source]

Get list of annotation collaborators

Args:
userId, str: User GUID (required) fileId, str: File ID (required)

Returns: GetCollaboratorsResponse

GetReviewerContacts(userId, **kwargs)[source]

Get list of reviewer contacts

Args:
userId, str: User GUID (required)

Returns: GetReviewerContactsResponse

GetSharedLinkAccessRights(userId, fileId, **kwargs)[source]

Get Shared Link Access Rights

Args:
userId, str: User GUID (required) fileId, str: File ID (required)

Returns: GetSharedLinkAccessRightsResponse

ListAnnotationReplies(userId, annotationId, after, **kwargs)[source]

Get list of annotation replies

Args:
userId, str: User GUID (required) annotationId, str: Annotation ID (required) after, long: After (required)

Returns: ListRepliesResponse

ListAnnotations(userId, fileId, **kwargs)[source]

Get list of annotations

Args:
userId, str: User GUID (required) fileId, str: File ID (required)

Returns: ListAnnotationsResponse

MoveAnnotation(userId, annotationId, body, **kwargs)[source]

Move annotation

Args:
userId, str: User GUID (required) annotationId, str: Annotation ID (required) body, Point: position (required)

Returns: MoveAnnotationResponse

MoveAnnotationMarker(userId, annotationId, body, **kwargs)[source]

Move Annotation Marker

Args:
userId, str: User GUID (required) annotationId, str: Annotation ID (required) body, MarkerPosition: Annotation marker position (required)

Returns: MoveAnnotationResponse

ResizeAnnotation(userId, annotationId, body, **kwargs)[source]

Resize annotation

Args:
userId, str: User GUID (required) annotationId, str: Annotation ID (required) body, AnnotationSizeInfo: position (required)

Returns: ResizeAnnotationResponse

SaveTextField(userId, annotationId, body, **kwargs)[source]

Save Text Of Text Field

Args:
userId, str: User GUID (required) annotationId, str: Annotation ID (required) body, TextFieldInfo: Text (required)

Returns: SaveAnnotationTextResponse

SetAnnotationAccess(userId, annotationId, body, **kwargs)[source]

Set Annotation Access

Args:
userId, str: User GUID (required) annotationId, str: Annotation ID (required) body, int: Annotation Access (required)

Returns: SetAnnotationAccessResponse

SetAnnotationCollaborators(userId, fileId, version, **kwargs)[source]

Set annotation collaborators

Args:
userId, str: User GUID (required) fileId, str: File ID (required) version, str: Annotation version (required) body, List[str]: Collaborators (optional)

Returns: SetCollaboratorsResponse

SetReviewerContacts(userId, **kwargs)[source]

Get list of reviewer contacts

Args:
userId, str: User GUID (required) body, List[ReviewerContactInfo]: Reviewer Contacts Array (optional)

Returns: GetReviewerContactsResponse

SetReviewerRights(userId, fileId, body, **kwargs)[source]

Set Reviewer Rights

Args:
userId, str: User GUID (required) fileId, str: File ID (required) body, List[ReviewerInfo]: Collaborators (required)

Returns: SetReviewerRightsResponse

SetSessionCallbackUrl(userId, fileId, body, **kwargs)[source]

Set Session Web Hook Callback Url

Args:
userId, str: User GUID (required) fileId, str: File GUID (required) body, str: Callback Url (required)

Returns: SetSessionCallbackUrlResponse

SetSharedLinkAccessRights(userId, fileId, body, **kwargs)[source]

Set Shared Link Access Rights

Args:
userId, str: User GUID (required) fileId, str: File ID (required) body, AnnotationReviewerRights: Access Rights for the collaborate link (required)

Returns: SetSharedLinkAccessRightsResponse

SetTextFieldColor(userId, annotationId, body, **kwargs)[source]

Save Text Of Text Field

Args:
userId, str: User GUID (required) annotationId, str: Annotation ID (required) body, int: Font Color (required)

Returns: SaveAnnotationTextResponse

basePath

ApiClient Module

class groupdocs.ApiClient.ApiClient(requestSigner=None)[source]

Bases: object

Generic API client for Swagger client library builds

addHeaders(**headers)[source]
callAPI(apiServer, resourcePath, method, queryParams, postData, headerParams=None, returnType=<type 'str'>)[source]
deserialize(obj, objClass)[source]

Derialize a JSON string into an object.

Args:
obj – string or object to be deserialized objClass – class literal for deserialzied object, or string of class name
Returns:
object – deserialized object
static encodeURI(url)[source]
static encodeURIComponent(url)[source]
static readAsDataURL(filePath)[source]
sanitizeForSerialization(obj)[source]

Dump an object into JSON for POSTing.

setDebug(flag, logFilepath=None)[source]
toPathValue(obj)[source]

Serialize a list to a CSV string, if necessary.

Args:
obj – data object to be serialized
Returns:
string – json serialization of object
exception groupdocs.ApiClient.ApiException(code, *args)[source]

Bases: exceptions.Exception

class groupdocs.ApiClient.DefaultRequestSigner[source]

Bases: groupdocs.ApiClient.RequestSigner

signContent(requestBody, headers)[source]
signUrl(url)[source]
class groupdocs.ApiClient.MethodRequest(*args, **kwargs)[source]

Bases: urllib2.Request

get_method()[source]
class groupdocs.ApiClient.RequestSigner[source]

Bases: object

signContent(requestBody, headers)[source]
signUrl(url)[source]

AsyncApi Module

class groupdocs.AsyncApi.AsyncApi(apiClient)[source]

Bases: object

AddJobDocument(userId, jobId, fileId, checkOwnership, **kwargs)[source]

Add job document

Args:
userId, str: User GUID (required) jobId, str: Job id or guid (required) fileId, str: File GUID (required) checkOwnership, bool: Check Document Ownership (required) formats, str: Formats (optional)

Returns: AddJobDocumentResponse

AddJobDocumentUrl(userId, jobId, absoluteUrl, **kwargs)[source]

Add job document url

Args:
userId, str: User GUID (required) jobId, str: Job id (required) absoluteUrl, str: Absolute Url (required) formats, str: Formats (optional)

Returns: AddJobDocumentResponse

Convert(userId, fileId, **kwargs)[source]
Args:
userId, str: User GUID (required) fileId, str: File GUID (required) emailResults, str: Email results (optional) description, str: Description (optional) printScript, bool: Print (optional) callbackUrl, str: Callback url (optional) new_type, str: Target type (optional)

Returns: ConvertResponse

CreateJob(userId, body, **kwargs)[source]

Create job

Args:
userId, str: User GUID (required) body, JobInfo: Job (required)

Returns: CreateJobResponse

DeleteJob(userId, jobGuid, **kwargs)[source]

Delete draft job

Args:
userId, str: User GUID (required) jobGuid, str: Job Guid (required)

Returns: DeleteResult

DeleteJobDocument(userId, jobGuid, documentId, **kwargs)[source]

Delete document from job

Args:
userId, str: User GUID (required) jobGuid, str: Job Guid (required) documentId, str: Document GUID (required)

Returns: DeleteResponse

GetJobDocuments(userId, jobId, **kwargs)[source]

Get job documents

Args:
userId, str: User GUID (required) jobId, str: Job id or guid (required) format, str: Format (optional)

Returns: GetJobDocumentsResponse

GetJobJson(userId, jobId, **kwargs)[source]

Get job json

Args:
userId, str: User GUID (required) jobId, str: Job id (required)

Returns: GetJobResponse

GetJobResources(userId, statusIds, **kwargs)[source]

Get job resources

Args:
userId, str: User GUID (required) statusIds, str: Comma separated job status identifiers (required) actions, str: Actions (optional) excludedActions, str: Excluded actions (optional)

Returns: GetJobResourcesResponse

GetJobs(userId, **kwargs)[source]

Get jobs

Args:
userId, str: User GUID (required) pageIndex, str: Page Index (optional) pageSize, str: Page Size (optional) datetime, str: Date (optional) statusIds, str: Comma separated status identifiers (optional) actions, str: Actions (optional) excludedActions, str: Excluded actions (optional) jobName, str: Filtred job name (optional) orderBy, str: Sorded column name (optional) orderAsc, bool: Order ASC (optional)

Returns: GetJobsResponse

GetJobsDocuments(userId, **kwargs)[source]

Get jobs documents

Args:
userId, str: User GUID (required) pageIndex, str: Page Index (optional) pageSize, str: Page Size (optional) actions, str: Actions (optional) excludedActions, str: Excluded actions (optional) orderBy, str: Order by (optional) orderAsc, bool: Order asc (optional)

Returns: GetJobsDocumentsResponse

GetPossibleConversions(userId, fileExt, **kwargs)[source]

Get Possible Conversions

Args:
userId, str: User GUID (required) fileExt, str: File extension to check (required)

Returns: GetPossibleConversions

UpdateJob(userId, jobId, body, **kwargs)[source]

Update job

Args:
userId, str: User GUID (required) jobId, str: Job id or Guid (required) body, JobInfo: Job (required)

Returns: UpdateJobResponse

basePath

ComparisonApi Module

class groupdocs.ComparisonApi.ComparisonApi(apiClient)[source]

Bases: object

Compare(userId, sourceFileId, targetFileId, callbackUrl, **kwargs)[source]
Args:
userId, str: User GUID (required) sourceFileId, str: Source File GUID (required) targetFileId, str: Target File GUID (required) callbackUrl, str: Callback Url (required)

Returns: CompareResponse

DownloadResult(resultFileId, **kwargs)[source]

Download comparison result file

Args:
resultFileId, str: Comparison result file GUID (required) format, str: Comparison result file format (optional)

Returns: stream

GetChanges(resultFileId, **kwargs)[source]

Get changes

Args:
resultFileId, str: Comparison result file GUID (required)

Returns: ChangesResponse

GetDocumentDetails(userId, guid, **kwargs)[source]

Get document details

Args:
userId, str: User GUID (required) guid, str: Document GUID (required)

Returns: DocumentDetailsResponse

UpdateChanges(resultFileId, body, **kwargs)[source]

Update changes

Args:
resultFileId, str: Comparison result file GUID (required) body, List[ChangeInfo]: Comparison changes to update (accept or reject) (required)

Returns: ChangesResponse

basePath

DocApi Module

class groupdocs.DocApi.DocApi(apiClient)[source]

Bases: object

GetDocumentAccessInfo(userId, fileId, **kwargs)[source]

Get document access info

Args:
userId, str: User GUID (required) fileId, str: File GUID (required)

Returns: DocumentAccessInfoResponse

GetDocumentContent(userId, fileId, contentType, **kwargs)[source]

Returns document content

Args:
userId, str: GroupDocs user global unique identifier. (required) fileId, str: Document global unique identifier. (required) contentType, str: Content type. (required)

Returns: GetDocumentContentResponse

GetDocumentFormats(userId, fileId, **kwargs)[source]

Get document formats

Args:
userId, str: User GUID (required) fileId, str: File GUID (required)

Returns: GetDocumentForeignTypesResponse

Returns document hyperlinks.

Args:
userId, str: GroupDocs user global unique identifier. (required) fileId, str: Document global unique identifier. (required)

Returns: GetHyperlinksResponse

GetDocumentMetadata(userId, fileId, **kwargs)[source]

Get document metadata

Args:
userId, str: User GUID (required) fileId, str: File GUID (required)

Returns: GetDocumentInfoResponse

GetDocumentMetadataByPath(userId, path, **kwargs)[source]

Returns document metadata

Args:
userId, str: User GUID (required) path, str: File path to return metadata for (required)

Returns: GetDocumentInfoResponse

GetDocumentPageImage(userId, fileId, pageNumber, dimension, **kwargs)[source]

Returns a stream of bytes representing a particular document page image.

Args:
userId, str: GroupDocs user global unique identifier. (required) fileId, str: Document global unique identifier. (required) pageNumber, int: Document page number to get image for. (required) dimension, str: Image dimension in format ‘&lt;width&gt;x&lt;height&gt;’ (one or both values can be omitted). (required) quality, int: Image qualiry in range 1-100. (optional) usePdf, bool: A flag indicating whether a document should be converted to PDF format before generating the image. (optional) expiresOn, bool: The date and time in milliseconds since epoch the URL expires. (optional)

Returns: stream

GetDocumentPagesImageUrls(userId, fileId, dimension, **kwargs)[source]

Returns a list of URLs pointing to document page images.

Args:
userId, str: GroupDocs user global unique identifier. (required) fileId, str: Document global unique identifier. (required) firstPage, int: Document page number to start from. (optional) pageCount, int: Page count to return URLs for. (optional) dimension, str: Image dimension in format ‘&lt;width&gt;x&lt;height&gt;’ (one or both values can be omitted). (required) quality, int: Image qualiry in range 1-100. (optional) usePdf, bool: A flag indicating whether a document should be converted to PDF format before generating the image. (optional) token, str: A document viewer session token returned by the View Document request. (optional)

Returns: GetImageUrlsResponse

GetDocumentTags(userId, fileId, **kwargs)[source]

Returns tags assigned to the document.

Args:
userId, str: GroupDocs user global unique identifier. (required) fileId, str: Document global unique identifier. (required)

Returns: GetTagsResponse

GetDocumentViews(userId, **kwargs)[source]

Get Document Views

Args:
userId, str: User GUID (required) startIndex, str: A historical view entry to start from. Historical entries are sorted from the recent to old ones (optional) pageSize, str: The total number of requested entries. If pageSize is equal to -1, all available entries will be returned (optional)

Returns: DocumentViewsResponse

GetEditLock(userId, fileId, **kwargs)[source]

Locks a document for editing and returns editing metadata.

Args:
userId, str: GroupDocs user global unique identifier. (required) fileId, str: Document global unique identifier. (required)

Returns: GetEditLockResponse

GetFolderSharers(userId, folderId, **kwargs)[source]

Get folder sharers

Args:
userId, str: User GUID (required) folderId, str: Folder Id (required)

Returns: SharedUsersResponse

GetSharedDocuments(userId, sharesTypes, **kwargs)[source]

Get shared documents

Args:
userId, str: User GUID (required) sharesTypes, str: Shares types (optional) pageIndex, str: Page index (optional) pageSize, str: Page size (optional) orderBy, str: Order by (optional) orderAsc, bool: Order asc (optional)

Returns: SharedDocumentsResponse

GetTemplateEditorFields(userId, fileId, **kwargs)[source]

Get template editor fields

Args:
userId, str: User GUID (required) fileId, str: File GUID (required)

Returns: TemplateEditorFieldsResponse

GetTemplateFields(userId, fileId, **kwargs)[source]

Get template fields

Args:
userId, str: User GUID (required) fileId, str: File GUID (required) includeGeometry, bool: Include geometry (optional)

Returns: TemplateFieldsResponse

RemoveDocumentTags(userId, fileId, **kwargs)[source]

Removes tags assigned to the document.

Args:
userId, str: GroupDocs user global unique identifier. (required) fileId, str: Document global unique identifier. (required)

Returns: RemoveTagsResponse

RemoveEditLock(userId, fileId, lockId, **kwargs)[source]

Removes edit lock for a document and replaces the document with its edited copy.

Args:
userId, str: GroupDocs user global unique identifier. (required) fileId, str: Document global unique identifier. (required) lockId, str: Lock Id. (required)

Returns: RemoveEditLockResponse

SetDocumentAccessMode(userId, fileId, **kwargs)[source]

Set document access mode

Args:
userId, str: User GUID (required) fileId, str: File GUID (required) mode, str: Mode (optional)

Returns: DocumentAccessInfoResponse

SetDocumentPassword(userId, fileId, body, **kwargs)[source]

Set document password

Args:
userId, str: User GUID (required) fileId, str: File GUID (required) body, str: Password (required)

Returns: SetDocumentPasswordResponse

SetDocumentTags(userId, fileId, **kwargs)[source]

Assign tags to the document.

Args:
userId, str: GroupDocs user global unique identifier. (required) fileId, str: Document global unique identifier. (required)

Returns: SetTagsResponse

SetDocumentUserStatus(userId, fileId, status, **kwargs)[source]

Set document user status

Args:
userId, str: User GUID (required) fileId, str: File GUID (required) status, str: Status (required)

Returns: DocumentUserStatusResponse

ShareDocument(userId, fileId, body, **kwargs)[source]

Share document

Args:
userId, str: User GUID (required) fileId, str: File ID - decimal type (required) body, List[str]: Sharers (required)

Returns: SharedUsersResponse

ShareFolder(userId, folderId, body, **kwargs)[source]

Share folder

Args:
userId, str: User GUID (required) folderId, str: Folder Id (required) body, List[str]: Sharers (required)

Returns: SharedUsersResponse

UnshareDocument(userId, fileId, **kwargs)[source]

Unshare document

Args:
userId, str: User GUID (required) fileId, str: File GUID (required)

Returns: SharedUsersResponse

UnshareFolder(userId, folderId, **kwargs)[source]

Unshare folder

Args:
userId, str: User GUID (required) folderId, str: Folder Id (required)

Returns: SharedUsersResponse

ViewDocument(userId, fileId, **kwargs)[source]

View Document

Args:
userId, str: User GUID (required) fileId, str: File GUID (required) pageNumber, str: Page Number (optional) pageCount, str: Page Count (optional) width, str: Width (optional) quality, str: Quality (optional) usePdf, str: Use Pdf (optional) passwordSalt, str: A password hash for password protected documents (optional)

Returns: ViewDocumentResponse

basePath

FileStream Module

class groupdocs.FileStream.FileStream(filePath=None, response=None, stream=None)[source]

Bases: object

This class encapsulates data needed either for file upload or download. All properties are initialized lazily on first access.

To use this class for file upload initialize it with absolute path to file on your filesystem.

To use this class for file download call fromHttp(response) method.

contentType
fileName
classmethod fromFile(filePath)[source]

filePath is an absolute path to file on your filesystem.

classmethod fromHttp(response)[source]

response is a file-like object with two additional methods: geturl() and info()

classmethod fromStream(stream, size, contentType='application/octet-stream')[source]

stream is a file-like object, i.e. stream = fopen(filename)

inputStream

returns file object

size

GroupDocsRequestSigner Module

class groupdocs.GroupDocsRequestSigner.GroupDocsRequestSigner(privateKey)[source]

Bases: groupdocs.ApiClient.RequestSigner

signContent(requestBody, headers)[source]
signUrl(url)[source]

MergeApi Module

class groupdocs.MergeApi.MergeApi(apiClient)[source]

Bases: object

AddDataSource(userId, body, **kwargs)[source]

Add datasource

Args:
userId, str: User GUID (required) body, Datasource: Datasource (required)

Returns: AddDatasourceResponse

AddDocumentQuestionnaire(userId, fileId, questionnaireId, **kwargs)[source]

Add document questionnaire

Args:
userId, str: User GUID (required) fileId, str: File GUID (required) questionnaireId, str: Questionnaire id (required)

Returns: AddDocumentQuestionnaireResponse

AddJobDocumentDataSource(userId, jobId, fileId, datasourceId, **kwargs)[source]

Add job document datasource

Args:
userId, str: User GUID (required) jobId, int: Job indetifier (required) fileId, int: File indetifier (required) datasourceId, int: Datasource indetifier (required)

Returns: AddDocumentDataSourceResponse

AddJobDocumentDataSourceFields(userId, jobId, fileId, body, **kwargs)[source]

Add job document datasource fields

Args:
userId, str: User GUID (required) jobId, str: Job id (required) fileId, str: File GUID (required) body, List[DatasourceField]: Fields (required)

Returns: AddDocumentDataSourceResponse

AddQuestionnaireCollector(userId, questionnaireId, body, **kwargs)[source]

Add questionnaire collector

Args:
userId, str: User global unique identifier (required) questionnaireId, str: Questionnaire identifier (required) body, QuestionnaireCollectorInfo: Questionnaire collector to be added (required)

Returns: AddQuestionnaireCollectorResponse

AddQuestionnaireExecution(userId, collectorId, body, **kwargs)[source]

Add questionnaire execution

Args:
userId, str: User GUID (required) collectorId, str: Questionnaire collector id (required) body, QuestionnaireExecutionInfo: Execution (required)

Returns: AddQuestionnaireExecutionResponse

AddQuestionnaireTemplateFields(userId, fileId, body, **kwargs)[source]

Add template editor fields to the specific document

Args:
userId, str: User GUID (required) fileId, str: File GUID (required) body, List[TemplateEditorField]: Array of template fields which should be added (required)

Returns: GetQuestionnaireTemplateResponse

CopyFileToTemplates(userId, path, **kwargs)[source]

Copy file to template

Args:
userId, str: User GUID (required) path, str: Path (required) mode, str: Mode (optional) Groupdocs_Copy, str: File ID (copy) (optional) Groupdocs_Move, str: File ID (move) (optional)

Returns: GetTemplatesResponse

CreateDocumentQuestionnaire(userId, fileId, body, **kwargs)[source]

Create document questionnaire

Args:
userId, str: User GUID (required) fileId, str: File GUID (required) body, QuestionnaireInfo: Questionnaire (required)

Returns: AddDocumentQuestionnaireResponse

CreateQuestionnaire(userId, body, **kwargs)[source]

Create questionnaire

Args:
userId, str: User GUID (required) body, QuestionnaireInfo: Questionnaire (required)

Returns: CreateQuestionnaireResponse

CreateQuestionnaireTemplate(userId, fileId, body, **kwargs)[source]

Create questionnaire template from file

Args:
userId, str: User GUID (required) fileId, str: File GUID (required) body, List[TemplateEditorField]: Array of template fields (required)

Returns: CreateQuestionnaireTemplateResponse

DecorateQuestionnaireCollector(userId, collectorId, body, **kwargs)[source]

Decorate questionnaire collector

Args:
userId, str: User global unique identifier (required) collectorId, str: Questionnaire collector global unique identifier (required) body, QuestionnaireCollectorStyle: Questionnaire collector style (required)

Returns: AddQuestionnaireCollectorStyleResponse

DeleteDataSource(userId, datasourceId, **kwargs)[source]

Delete datasource fields

Args:
userId, str: User GUID (required) datasourceId, str: Datasource id (required)

Returns: DeleteDatasourceResponse

DeleteDataSourceList(userId, **kwargs)[source]

Delete list of datasource fields

Args:
userId, str: User GUID (required) body, List[str]: List of Id (optional)

Returns: DeleteDatasourceListResponse

DeleteDocumentQuestionnaire(userId, fileId, questionnaireId, **kwargs)[source]

Delete document questionnaire

Args:
userId, str: User GUID (required) fileId, str: File GUID (required) questionnaireId, str: Questionnaire id (required)

Returns: DeleteDocumentQuestionnaireResponse

DeleteQuestionnaire(userId, questionnaireId, **kwargs)[source]

Delete questionnaire

Args:
userId, str: User GUID (required) questionnaireId, str: Questionnaire id (required)

Returns: DeleteQuestionnaireResponse

DeleteQuestionnaireCollector(userId, collectorId, **kwargs)[source]

Removes questionnaire collector

Args:
userId, str: User global unique identifier (required) collectorId, str: Questionnaire collector global unique identifier (required)

Returns: DeleteQuestionnaireCollectorResponse

DeleteQuestionnaireCollectorList(userId, **kwargs)[source]

Removes questionnaire collector

Args:
userId, str: User global unique identifier (required) body, List[str]: Collector’s GUID list (optional)

Returns: DeleteQuestionnaireCollectorListResponse

DeleteQuestionnaireExecution(userId, executionId, **kwargs)[source]

Removes questionnaire execution

Args:
userId, str: User GUID (required) executionId, str: Execution id (required)

Returns: DeleteQuestionnaireExecutionResponse

DeleteQuestionnaireExecutionList(userId, **kwargs)[source]

Removes questionnaire execution

Args:
userId, str: User GUID (required) body, List[str]: List of GUID (optional)

Returns: DeleteQuestionnaireExecutionListResponse

DeleteQuestionnaireTemplateFields(userId, fileId, body, **kwargs)[source]

Delete template’s fields

Args:
userId, str: User GUID (required) fileId, str: File GUID (required) body, List[TemplateEditorField]: Array of template fields which should be deleted (required)

Returns: GetQuestionnaireTemplateResponse

DeleteQuestionnairesList(userId, **kwargs)[source]

Delete list of questionnaires by GUIDs

Args:
userId, str: User GUID (required) body, List[str]: List of GUID (optional)

Returns: DeleteQuestionnaireListResponse

FillExecution(userId, executionId, datasourceId, **kwargs)[source]

Scheduled questionnaire execution fullfilment job

Args:
userId, str: User global unique identifier (required) executionId, str: Execution global unique identifier to fill (required) datasourceId, str: Datasource identifier (required) targetType, str: Filled document type (optional) emailResults, str: Email results (optional) callbackUrl, str: Callback url (optional)

Returns: MergeTemplateResponse

FillQuestionnaire(userId, collectorId, datasourceId, **kwargs)[source]

Merge datasource

Args:
userId, str: User global unique identifier (required) collectorId, str: Collector global unique identifier to fill (required) datasourceId, str: Datasource identifier (required) targetType, str: Filled document type (optional) emailResults, str: Email results (optional) callbackUrl, str: Callback url (optional)

Returns: MergeTemplateResponse

GetDataSource(userId, datasourceId, **kwargs)[source]

Get datasource

Args:
userId, str: User GUID (required) datasourceId, str: Datasource id (required) fields, str: Fields (optional)

Returns: GetDatasourceResponse

GetDocumentByQuestionnaire(userId, questionnaireId, **kwargs)[source]

Get associated document by questionnaire

Args:
userId, str: User GUID (required) questionnaireId, str: Questionnaire GUID (required)

Returns: GetQuestionnaireDocumentResponse

GetDocumentQuestionnaires(userId, fileId, **kwargs)[source]

Get document questionnaires

Args:
userId, str: User GUID (required) fileId, str: File GUID (required)

Returns: GetDocumentQuestionnairesResponse

GetQuestionnaire(userId, questionnaireId, **kwargs)[source]

Get questionnaire

Args:
userId, str: User GUID (required) questionnaireId, str: Questionnaire id (required)

Returns: GetQuestionnaireResponse

GetQuestionnaireByCollector(userId, collectorId, **kwargs)[source]

Get questionnaire by collector guid

Args:
userId, str: User GUID (required) collectorId, str: Collector GUID (required)

Returns: GetQuestionnaireResponse

GetQuestionnaireCollector(userId, collectorId, **kwargs)[source]

Returns questionnaire collector

Args:
userId, str: User global unique identifier (required) collectorId, str: Questionnaire collector global unique identifier (required)

Returns: GetQuestionnaireCollectorResponse

GetQuestionnaireCollectorExecutions(userId, collectorId, **kwargs)[source]

Get questionnaire collector executions

Args:
userId, str: User GUID (required) collectorId, str: Questionnaire collector global unique identifier (required)

Returns: GetQuestionnaireExecutionsResponse

GetQuestionnaireCollectorStyle(userId, collectorId, **kwargs)[source]

Returns questionnaire collector style

Args:
userId, str: User global unique identifier (required) collectorId, str: Questionnaire collector global unique identifier (required)

Returns: GetQuestionnaireCollectorStyleResponse

GetQuestionnaireCollectors(userId, questionnaireId, orderBy, isAsc, **kwargs)[source]

Get questionnaire collectors

Args:
userId, str: User global unique identifier (required) questionnaireId, str: Questionnaire identifier (required) orderBy, str: Order by column (required) isAsc, bool: Order by ascending or descending (required)

Returns: GetQuestionnaireCollectorsResponse

GetQuestionnaireDataSources(userId, questionnaireId, **kwargs)[source]

Get questionnaire datasources

Args:
userId, str: User GUID (required) questionnaireId, str: QuestionnaireId id (required) includeFields, bool: Include fields (optional)

Returns: GetDatasourcesResponse

GetQuestionnaireExecution(userId, executionId, **kwargs)[source]

Get questionnaire execution

Args:
userId, str: User GUID (required) executionId, str: Questionnaire execution global unique identifier (required)

Returns: GetQuestionnaireExecutionResponse

GetQuestionnaireExecutions(userId, questionnaireId, **kwargs)[source]

Get questionnaire executions

Args:
userId, str: User GUID (required) questionnaireId, str: Questionnaire global unique identifier (required)

Returns: GetQuestionnaireExecutionsResponse

GetQuestionnaireFields(userId, questionnaireId, **kwargs)[source]

Get questionnaire fields

Args:
userId, str: User global unique identifier (required) questionnaireId, str: Questionnaire global unique identifier (required) includeGeometry, bool: A flag indicating whether fields coordinates and size should be included into the response. (optional)

Returns: TemplateFieldsResponse

GetQuestionnaireMetadata(userId, questionnaireId, **kwargs)[source]

Get questionnaire metadata

Args:
userId, str: User global unique identifier (required) questionnaireId, str: Questionnaire global unique identifier (required)

Returns: GetQuestionnaireMetadataResponse

GetQuestionnaires(userId, **kwargs)[source]

Get questionnaires

Args:
userId, str: User GUID (required) status, str: Questionnaire status to filter by (optional) pageNumber, int: Page number to return questionnaires on (optional) pageSize, int: Number of questionnaires to return (optional) orderBy, str: Order by column (optional) isAscending, bool: Order by ascending or descending (optional)

Returns: GetQuestionnairesResponse

GetQuestionnairesByName(userId, **kwargs)[source]

Get questionnaires

Args:
userId, str: User GUID (required) name, str: Questionnaire name (optional) status, str: Questionnaire status to filter by (optional) pageNumber, int: Page number to return questionnaires on (optional) pageSize, int: Number of questionnaires to return (optional) orderBy, str: Order by column (optional) isAscending, bool: Order by ascending or descending (optional)

Returns: GetQuestionnairesResponse

GetTemplates(userId, **kwargs)[source]

Get template documents information

Args:
userId, str: User global unique identifier (required) orderBy, str: Order by column (optional) isAscending, bool: Order by ascending or descending (optional)

Returns: GetTemplatesResponse

MergeDatasource(userId, fileId, datasourceId, **kwargs)[source]

Merge datasource

Args:
userId, str: User GUID (required) fileId, str: File GUID (required) datasourceId, str: Datasource id (required) targetType, str: Target type (optional) emailResults, str: Email results (optional)

Returns: MergeTemplateResponse

MergeDatasourceFields(userId, fileId, body, **kwargs)[source]

Merge datasource fields

Args:
userId, str: User GUID (required) fileId, str: File GUID (required) targetType, str: Target type (optional) emailResults, str: Email results (optional) assemblyName, str: Assembly name (optional) body, List[DatasourceField]: Fields (required)

Returns: MergeTemplateResponse

UpdateDataSource(userId, datasourceId, body, **kwargs)[source]

Update datasource

Args:
userId, str: User GUID (required) datasourceId, str: Datasource id (required) body, Datasource: Datasource (required)

Returns: AddDatasourceResponse

UpdateDataSourceFields(userId, datasourceId, body, **kwargs)[source]

Update datasource fields

Args:
userId, str: User GUID (required) datasourceId, str: Datasource id (required) body, Datasource: Datasource (required)

Returns: AddDatasourceResponse

UpdateQuestionnaire(userId, questionnaireId, body, **kwargs)[source]

Update questionnaire

Args:
userId, str: User GUID (required) questionnaireId, str: Questionnaire id (required) body, QuestionnaireInfo: Questionnaire (required)

Returns: UpdateQuestionnaireResponse

UpdateQuestionnaireCollector(userId, collectorId, body, **kwargs)[source]

Update questionnaire collector

Args:
userId, str: User global unique identifier (required) collectorId, str: Questionnaire collector global unique identifier (required) body, QuestionnaireCollectorInfo: Questionnaire collector data (required)

Returns: UpdateQuestionnaireCollectorResponse

UpdateQuestionnaireExecution(userId, executionId, body, **kwargs)[source]

Update questionnaire execution

Args:
userId, str: User GUID (required) executionId, str: Execution id (required) body, QuestionnaireExecutionInfo: Execution (required)

Returns: UpdateQuestionnaireExecutionResponse

UpdateQuestionnaireExecutionStatus(userId, executionId, body, **kwargs)[source]

Update questionnaire execution status

Args:
userId, str: User GUID (required) executionId, str: Execution id (required) body, str: Status (required)

Returns: UpdateQuestionnaireExecutionResponse

UpdateQuestionnaireMetadata(userId, questionnaireId, body, **kwargs)[source]

Update questionnaire metadata

Args:
userId, str: User global unique identifier (required) questionnaireId, str: Questionnaire global unique identifier (required) body, QuestionnaireMetadata: Questionnaire metadata to update (required)

Returns: UpdateQuestionnaireResponse

UpdateQuestionnaireTemplateFields(userId, fileId, body, **kwargs)[source]

Update template’s fields

Args:
userId, str: User GUID (required) fileId, str: File GUID (required) body, List[TemplateEditorField]: Array of template fields which should be updated (required)

Returns: GetQuestionnaireTemplateResponse

basePath

MgmtApi Module

class groupdocs.MgmtApi.MgmtApi(apiClient)[source]

Bases: object

AddStorageProvider(userId, provider, body, **kwargs)[source]

Adds a new storage provider configuration.

Args:
userId, str: User GUID (required) provider, str: Storage provider name (required) body, StorageProviderInfo: Storage provider configuration details (required)

Returns: AddStorageProviderResponse

ChangeAlienUserPassword(callerId, userId, body, **kwargs)[source]

Change alien user password

Args:
callerId, str: Caller GUID (required) userId, str: User GUID (required) body, UserPasswordInfo: Password (required)

Returns: ChangePasswordResponse

ChangeUserPassword(userId, body, **kwargs)[source]

Change user password

Args:
userId, str: User GUID (required) body, UserPasswordInfo: Password (required)

Returns: ChangePasswordResponse

CreateUser(callerId, body, **kwargs)[source]

Create user

Args:
callerId, str: Caller GUID (required) body, UserInfo: Payload (required)

Returns: CreateUserResponse

CreateUserLogin(callerId, userId, password, **kwargs)[source]

Create user login

Args:
callerId, str: Caller GUID (required) userId, str: User name (required) password, str: Password (required)

Returns: UserInfoResponse

DeleteAccount(userId, **kwargs)[source]

Closes user’s account.

Args:
userId, str: User global unique identifier (required)

Returns: DeleteAccountResponse

DeleteAccountUser(adminId, userName, **kwargs)[source]

Delete account user.

Args:
adminId, str: Administrator GUID (required) userName, str: User name (required)

Returns: DeleteAccountUserResponse

GenerateKeyForUser(userId, area, **kwargs)[source]

Generates new active user embed key.

Args:
userId, str: User GUID (required) area, str: Application area where the key is (required)

Returns: GetUserEmbedKeyResponse

GetAccount(userId, **kwargs)[source]

Returns an account information.

Args:
userId, str: User GUID (required)

Returns: GetAccountResponse

GetAccountUsers(adminId, **kwargs)[source]

Returns account user list.

Args:
adminId, str: Administrator GUID (required)

Returns: GetAccountUsersResponse

GetAlienUserProfile(callerId, userId, **kwargs)[source]

Get alien user profile

Args:
callerId, str: Caller GUID (required) userId, str: User GUID (required)

Returns: UserInfoResponse

GetRoles(userId, **kwargs)[source]

Returns a list of user roles.

Args:
userId, str: User GUID (required)

Returns: GetRolesResponse

GetStorageProviders(userId, **kwargs)[source]

Returns user’s storage providers.

Args:
userId, str: User GUID (required)

Returns: GetStorageProvidersResponse

GetUserEmbedKey(userId, area, **kwargs)[source]

Returns active user embed key.

Args:
userId, str: User GUID (required) area, str: Application area where the key is (required)

Returns: GetUserEmbedKeyResponse

GetUserEmbedKeyFromGuid(callerId, guid, **kwargs)[source]

Returns embed key by GUID.

Args:
callerId, str: UserId invoked the service (required) guid, str: Key GUID (required)

Returns: GetUserEmbedKeyResponse

GetUserProfile(userId, **kwargs)[source]

Get user profile

Args:
userId, str: User GUID (required)

Returns: UserInfoResponse

GetUserProfileByClaimedToken(callerId, token, **kwargs)[source]

Get user profile by claimed token

Args:
callerId, str: Caller GUID (required) token, str: Token (required)

Returns: UserInfoResponse

GetUserProfileByResetToken(callerId, token, **kwargs)[source]

Get user profile by reset token

Args:
callerId, str: Caller GUID (required) token, str: Token (required)

Returns: UserInfoResponse

GetUserProfileByVerifToken(callerId, token, **kwargs)[source]

Get user profile by verif token

Args:
callerId, str: Caller GUID (required) token, str: Token (required)

Returns: UserInfoResponse

GetUserRoles(callerId, userId, **kwargs)[source]

Returns a list of user roles.

Args:
callerId, str: Caller GUID (required) userId, str: User GUID (required)

Returns: GetRolesResponse

ResetUserPassword(callerId, userId, **kwargs)[source]

Reset user password

Args:
callerId, str: Caller GUID (required) userId, str: User GUID (required)

Returns: ResetPasswordResponse

Revoke(userId, **kwargs)[source]

Revoke private key

Args:
userId, str: User GUID (required)

Returns: RevokeResponse

SetUserRoles(callerId, userId, body, **kwargs)[source]

Set user roles.

Args:
callerId, str: Caller GUID (required) userId, str: User GUID (required) body, List[RoleInfo]: A list of user roles (required)

Returns: SetUserRolesResponse

UpdateAccountUser(adminId, userName, body, **kwargs)[source]

Create or update account user.

Args:
adminId, str: Administrator GUID (required) userName, str: User name (required) body, UserInfo: User details (required)

Returns: UpdateAccountUserResponse

UpdateAlienUserProfile(callerId, userId, body, **kwargs)[source]

Update alien user profile

Args:
callerId, str: Caller GUID (required) userId, str: User GUID (required) body, UserInfo: Info (required)

Returns: UpdateUserResponse

UpdateStorageProvider(userId, provider, body, **kwargs)[source]

Updates user’s storage provider configuration.

Args:
userId, str: User GUID (required) provider, str: Storage provider name (required) body, StorageProviderInfo: Storage provider configuration details (required)

Returns: UpdateStorageProviderResponse

UpdateUserProfile(userId, body, **kwargs)[source]

Update user profile

Args:
userId, str: User GUID (required) body, UserInfo: Info (required)

Returns: UpdateUserResponse

basePath

PostApi Module

class groupdocs.PostApi.PostApi(apiClient)[source]

Bases: object

CompressByPost(userId, fileId, archiveType, **kwargs)[source]

Compress by post

Args:
userId, str: User GUID (required) fileId, str: File GUID (required) archiveType, str: Archive Type (required)

Returns: CompressResponse

DeleteByPost(userId, fileId, **kwargs)[source]

Delete by post

Args:
userId, str: User GUID (required) fileId, str: File GUID (required)

Returns: DeleteResponse

DeleteFromFolderByPost(userId, path, **kwargs)[source]

Delete from folder by post

Args:
userId, str: User GUID (required) path, str: Path (required)

Returns: DeleteResponse

RenameByPost(userId, fileId, newName, **kwargs)[source]

Rename by post

Args:
userId, str: User GUID (required) fileId, str: File GUID (required) newName, str: New name (required)

Returns: RenameResponse

basePath

SharedApi Module

class groupdocs.SharedApi.SharedApi(apiClient)[source]

Bases: object

Download(guid, fileName, **kwargs)[source]
Args:
guid, str: GUID (required) fileName, str: File name (required) render, bool: Render (optional)

Returns: stream

GetHtml(guid, **kwargs)[source]

Get html

Args:
guid, str: GUID (required)

Returns: stream

GetPackage(path, **kwargs)[source]

Get package

Args:
path, str: Path (required)

Returns: stream

GetXml(guid, **kwargs)[source]

Get xml

Args:
guid, str: GUID (required)

Returns: stream

LoginUser(userName, body, **kwargs)[source]

Logins user using user name and password

Args:
userName, str: User name (required) body, str: Password (required)

Returns: UserInfoResponse

basePath

SignatureApi Module

class groupdocs.SignatureApi.SignatureApi(apiClient)[source]

Bases: object

AddContact(userId, body, **kwargs)[source]

Add contact

Args:
userId, str: User GUID (required) body, SignatureContactSettingsInfo: Contact data (required)

Returns: SignatureContactResponse

AddContactIntegration(userId, **kwargs)[source]

Add Contact Integration Authorization

Args:
userId, str: User GUID (required) body, SignatureContactIntegrationSettings: Authorization settings (optional)

Returns: SignatureStatusResponse

AddPredefinedList(userId, body, **kwargs)[source]

Add predefined list

Args:
userId, str: User GUID (required) body, SignaturePredefinedListSettingsInfo: List data (required)

Returns: SignaturePredefinedListResponse

AddSignatureEnvelopeDocument(userId, envelopeGuid, documentGuid, **kwargs)[source]

Add document in envelope

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) documentGuid, str: Document GUID (required) order, int: Document order (optional) parseFields, bool: Try to parse fields in document (optional)

Returns: SignatureEnvelopeDocumentResponse

AddSignatureEnvelopeField(userId, envelopeGuid, documentGuid, recipientGuid, fieldGuid, **kwargs)[source]

Add signature field for document in envelope

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) documentGuid, str: Document GUID (required) recipientGuid, str: Recipient GUID (required) fieldGuid, str: Field GUID (required) body, SignatureEnvelopeFieldSettingsInfo: Settings of the field (optional)

Returns: SignatureEnvelopeFieldsResponse

AddSignatureEnvelopeRecipient(userId, envelopeGuid, recipientEmail, recipientFirstName, recipientLastName, roleGuid, **kwargs)[source]

Add signature envelope recipient

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) recipientEmail, str: Recipient email (required) recipientFirstName, str: Recipient first name (required) recipientLastName, str: Recipient last name (required) roleGuid, str: Recipient role GUID (required) order, int: Recipient order (optional)

Returns: SignatureEnvelopeRecipientResponse

AddSignatureFormDocument(userId, formGuid, documentGuid, **kwargs)[source]

Add document in form

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required) documentGuid, str: Document GUID (required) order, int: Document order (optional) parseFields, bool: Try to parse fields in document (optional)

Returns: SignatureFormDocumentResponse

AddSignatureFormField(userId, formGuid, documentGuid, fieldGuid, **kwargs)[source]

Add signature field for document in form

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required) documentGuid, str: Document GUID (required) fieldGuid, str: Field GUID (required) body, SignatureFormFieldSettingsInfo: Settings of the field (optional)

Returns: SignatureFormFieldResponse

AddSignatureTemplateDocument(userId, templateGuid, documentGuid, **kwargs)[source]

Add document to template

Args:
userId, str: User GUID (required) templateGuid, str: Template GUID (required) documentGuid, str: Document GUID (required) order, int: Display order of the document (optional) parseFields, bool: Try to parse fields in document (optional)

Returns: SignatureTemplateDocumentResponse

AddSignatureTemplateField(userId, templateGuid, documentGuid, recipientGuid, fieldGuid, **kwargs)[source]

Add signature template field

Args:
userId, str: User GUID (required) templateGuid, str: Template GUID (required) documentGuid, str: Document GUID (required) recipientGuid, str: Recipient GUID (required) fieldGuid, str: Field GUID (required) body, SignatureTemplateFieldSettingsInfo: Settings of the field (optional)

Returns: SignatureTemplateFieldResponse

AddSignatureTemplateRecipient(userId, templateGuid, nickname, roleGuid, **kwargs)[source]

Add recipient to the template

Args:
userId, str: User GUID (required) templateGuid, str: Template GUID (required) nickname, str: Nickname of the recipient (required) roleGuid, str: Role GUID (required) order, int: Display order of the recipient (optional)

Returns: SignatureTemplateRecipientResponse

ArchiveSignatureEnvelope(userId, envelopeGuid, **kwargs)[source]

Archive envelope

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required)

Returns: SignatureStatusResponse

ArchiveSignatureForm(userId, formGuid, **kwargs)[source]

Archive signature form

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required)

Returns: SignatureStatusResponse

AssignSignatureEnvelopeField(userId, envelopeGuid, documentGuid, fieldGuid, **kwargs)[source]

Assign signature envelope field

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) documentGuid, str: Document GUID (required) fieldGuid, str: Field GUID (required) body, SignatureEnvelopeAssignFieldSettingsInfo: Settings of the field (optional)

Returns: SignatureEnvelopeFieldResponse

AssignSignatureTemplateField(userId, templateGuid, documentGuid, fieldGuid, **kwargs)[source]

Assign signature template field

Args:
userId, str: User GUID (required) templateGuid, str: Template GUID (required) documentGuid, str: Document GUID (required) fieldGuid, str: Field GUID (required) body, SignatureTemplateAssignFieldSettingsInfo: Settings of the field (optional)

Returns: SignatureTemplateFieldResponse

CancelSignatureEnvelope(userId, envelopeGuid, **kwargs)[source]

Cancel envelope

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required)

Returns: SignatureStatusResponse

CompleteSignatureForm(userId, formGuid, **kwargs)[source]

Complete signature form

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required)

Returns: SignatureStatusResponse

CreateSignature(userId, name, **kwargs)[source]

Create user signature

Args:
userId, str: User GUID (required) name, str: Signature name (required) body, SignatureSignatureSettingsInfo: Settings of the signature (optional)

Returns: SignatureSignatureResponse

CreateSignatureEnvelope(userId, **kwargs)[source]

Create signature envelope

Args:
userId, str: User GUID (required) name, str: Envelope name (optional) templateGuid, str: A templateGuid of the template which will be used to created the new envelope (optional) envelopeGuid, str: A envelopeGuid of the envelope which will be used to created the new envelope (optional) documentGuid, str: A documentGuid of the document which will be added to the new created envelope (optional) parseFields, bool: Try to parse fields in document (optional) body, SignatureEnvelopeSettingsInfo: Settings of the new envelope (optional)

Returns: SignatureEnvelopeResponse

CreateSignatureField(userId, **kwargs)[source]

Create signature field

Args:
userId, str: User GUID (required) body, SignatureFieldSettingsInfo: Settings of the new field (optional)

Returns: SignatureFieldResponse

CreateSignatureForm(userId, **kwargs)[source]

Create signature form

Args:
userId, str: User GUID (required) name, str: Form name (optional) templateGuid, str: A templateGuid of the template which will be used to created the new form (optional) assemblyGuid, str: A guid of the assembly which will be used to created the new form (optional) formGuid, str: A formGuid of the form which will be used to created the new form (optional) body, SignatureFormSettingsInfo: Settings of the new form (optional)

Returns: SignatureFormResponse

CreateSignatureTemplate(userId, name, **kwargs)[source]

Create template

Args:
userId, str: User GUID (required) name, str: Template name (required) templateGuid, str: Template GUID of the template that will be used to create the new template (optional) envelopeGuid, str: Envelope GUID of the envelope that will be used to create the new template (optional) body, SignatureTemplateSettingsInfo: Settings of the template (optional)

Returns: SignatureTemplateResponse

DeclineEnvelope(userId, envelopeGuid, recipientGuid, **kwargs)[source]

Decline envelope

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) recipientGuid, str: Recipient GUID (required)

Returns: SignatureStatusResponse

DelegateEnvelopeRecipient(userId, envelopeGuid, recipientGuid, recipientEmail, recipientFirstName, recipientLastName, **kwargs)[source]

Delegate envelope recipient

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) recipientGuid, str: Recipient GUID (required) recipientEmail, str: Delegated recipient email (required) recipientFirstName, str: Delegated recipient first name (required) recipientLastName, str: Delegated recipient last name (required)

Returns: SignatureStatusResponse

DeleteContact(userId, contactGuid, **kwargs)[source]

Delete contact

Args:
userId, str: User GUID (required) contactGuid, str: Contact GUID (required)

Returns: SignatureContactResponse

DeletePredefinedList(userId, listGuid, **kwargs)[source]

Delete predefined list

Args:
userId, str: User GUID (required) listGuid, str: List GUID (required)

Returns: SignaturePredefinedListsResponse

DeleteSignature(userId, signatureGuid, **kwargs)[source]

Delete user signature

Args:
userId, str: User GUID (required) signatureGuid, str: Signature GUID (required)

Returns: SignatureStatusResponse

DeleteSignatureEnvelope(userId, envelopeGuid, **kwargs)[source]

Delete signature envelope

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required)

Returns: SignatureStatusResponse

DeleteSignatureEnvelopeDocument(userId, envelopeGuid, documentGuid, **kwargs)[source]

Delete document from envelope

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) documentGuid, str: Document GUID (required)

Returns: SignatureStatusResponse

DeleteSignatureEnvelopeField(userId, envelopeGuid, fieldGuid, **kwargs)[source]

Delete signature envelope field

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) fieldGuid, str: Field GUID (required)

Returns: SignatureStatusResponse

DeleteSignatureEnvelopeFieldLocation(userId, envelopeGuid, fieldGuid, locationGuid, **kwargs)[source]

Remove signature envelope field location

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) fieldGuid, str: Field GUID (required) locationGuid, str: Field location GUID (required)

Returns: SignatureStatusResponse

DeleteSignatureEnvelopeRecipient(userId, envelopeGuid, recipientGuid, **kwargs)[source]

Delete signature envelope recipient

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) recipientGuid, str: Recipient GUID (required)

Returns: SignatureStatusResponse

DeleteSignatureField(userId, fieldGuid, **kwargs)[source]

Delete signature field

Args:
userId, str: User GUID (required) fieldGuid, str: Field GUID (required)

Returns: SignatureStatusResponse

DeleteSignatureForm(userId, formGuid, **kwargs)[source]

Delete signature form

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required)

Returns: SignatureStatusResponse

DeleteSignatureFormDocument(userId, formGuid, documentGuid, **kwargs)[source]

Delete document from form

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required) documentGuid, str: Document GUID (required)

Returns: SignatureStatusResponse

DeleteSignatureFormField(userId, formGuid, fieldGuid, **kwargs)[source]

Delete signature form field

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required) fieldGuid, str: Field GUID (required)

Returns: SignatureStatusResponse

DeleteSignatureFormFieldLocation(userId, formGuid, fieldGuid, locationGuid, **kwargs)[source]

Remove signature form field location

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required) fieldGuid, str: Field GUID (required) locationGuid, str: Field location GUID (required)

Returns: SignatureStatusResponse

DeleteSignatureTemplate(userId, templateGuid, **kwargs)[source]

Delete template

Args:
userId, str: User GUID (required) templateGuid, str: Template GUID (required)

Returns: SignatureStatusResponse

DeleteSignatureTemplateDocument(userId, templateGuid, documentGuid, **kwargs)[source]

Remove document from template

Args:
userId, str: User GUID (required) templateGuid, str: Template GUID (required) documentGuid, str: Document GUID (required)

Returns: SignatureStatusResponse

DeleteSignatureTemplateField(userId, templateGuid, fieldGuid, **kwargs)[source]

Delete signature template field

Args:
userId, str: User GUID (required) templateGuid, str: Template GUID (required) fieldGuid, str: Field GUID (required)

Returns: SignatureTemplateResponse

DeleteSignatureTemplateFieldLocation(userId, templateGuid, fieldGuid, locationGuid, **kwargs)[source]

Delete signature template field location

Args:
userId, str: User GUID (required) templateGuid, str: Template GUID (required) fieldGuid, str: Field GUID (required) locationGuid, str: Field location GUID (required)

Returns: SignatureStatusResponse

DeleteSignatureTemplateRecipient(userId, templateGuid, recipientGuid, **kwargs)[source]

Remove recipient from template

Args:
userId, str: User GUID (required) templateGuid, str: Template GUID (required) recipientGuid, str: Recipient GUID (required)

Returns: SignatureStatusResponse

FillEnvelopeField(userId, envelopeGuid, documentGuid, recipientGuid, fieldGuid, **kwargs)[source]

Fill envelope field

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) documentGuid, str: Document GUID (required) recipientGuid, str: Recipient GUID (required) fieldGuid, str: Field GUID (required) signatureGuid, str: SignatureId GUID (optional) body, stream: Data to be placed in field (optional)

Returns: SignatureEnvelopeFieldResponse

GetContacts(userId, **kwargs)[source]

Get contacts

Args:
userId, str: User GUID (required) page, int: Page number (optional) records, int: Records count to be returned (optional) firstName, str: Filter by firstName (optional) lastName, str: Filter by lastName (optional) email, str: Filter by email (optional) useAnd, bool: Filter uses AND instead of default OR between parameters (optional)

Returns: SignatureContactsResponse

GetEnvelopeAuditLogs(userId, envelopeGuid, **kwargs)[source]

Get envelope audit logs

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required)

Returns: SignatureEnvelopeAuditLogsResponse

GetFieldsList(userId, **kwargs)[source]

Get signature fields

Args:
userId, str: User GUID (required) fieldGuid, str: Filter fields by id (optional)

Returns: SignatureFieldsResponse

GetFormAuditLogs(userId, formGuid, **kwargs)[source]

Get form audit logs

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required)

Returns: SignatureFormAuditLogsResponse

GetRecipientSignatureEnvelopes(userId, **kwargs)[source]

Get signature envelopes where the user is recipient

Args:
userId, str: User GUID (required) statusId, str: Filter envelopes by statusId (optional) page, int: Show records for page number (optional) records, int: Show records count (optional)

Returns: SignatureEnvelopesResponse

GetRolesList(userId, **kwargs)[source]

Get signature roles

Args:
userId, str: User GUID (required) roleGuid, str: Filter roles by GUID (optional)

Returns: SignatureRolesResponse

GetSignDocumentStatus(userId, jobGuid, **kwargs)[source]

Get sign documents status

Args:
userId, str: User GUID (required) jobGuid, str: Job GUID (required)

Returns: SignatureSignDocumentStatusResponse

GetSignatureEnvelope(userId, envelopeGuid, **kwargs)[source]

Get signature envelope

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required)

Returns: SignatureEnvelopeResponse

GetSignatureEnvelopeDocuments(userId, envelopeGuid, **kwargs)[source]

Get documents in envelope

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required)

Returns: SignatureEnvelopeDocumentsResponse

GetSignatureEnvelopeFieldData(envelopeGuid, recipientGuid, fieldGuid, **kwargs)[source]

Get signed envelope field data

Args:
envelopeGuid, str: Envelope GUID (required) recipientGuid, str: Recipient GUID (required) fieldGuid, str: Field GUID (required)

Returns: stream

GetSignatureEnvelopeFields(userId, envelopeGuid, **kwargs)[source]

Get signature field for document in envelope per recipient

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) documentGuid, str: Document GUID (optional) recipientGuid, str: Recipient GUID (optional) fieldGuid, str: Field GUID (optional)

Returns: SignatureEnvelopeFieldsResponse

GetSignatureEnvelopeRecipients(userId, envelopeGuid, **kwargs)[source]

Get signature envelope recipients

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required)

Returns: SignatureEnvelopeRecipientsResponse

GetSignatureEnvelopeResources(userId, **kwargs)[source]

Get envelope resources

Args:
userId, str: User GUID (required) statusIds, str: Envelope status identifier - comma separated list (optional)

Returns: SignatureEnvelopeResourcesResponse

GetSignatureEnvelopes(userId, **kwargs)[source]

Get signature envelopes

Args:
userId, str: User GUID (required) statusId, int: Filter envelopes by statusId (optional) page, int: Show records for page number (optional) records, int: Show records count (optional) originalDocumentMD5, str: Filter envelopes by original document md5 checksum (optional) recipientEmail, str: Filter envelopes by recipient email (optional) datetime, str: Filter envelopes by date (optional) name, str: Filter envelopes by name (optional) tag, str: Filter envelopes by tag (optional)

Returns: SignatureEnvelopesResponse

GetSignatureForm(userId, formGuid, **kwargs)[source]

Get signature form

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required)

Returns: SignatureFormResponse

GetSignatureFormDocumentFields(userId, formGuid, documentGuid, **kwargs)[source]

Get form fields for document in form per participant

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required) documentGuid, str: Document GUID (required) fieldGuid, str: Field GUID (optional)

Returns: SignatureFormFieldsResponse

GetSignatureFormDocuments(userId, formGuid, **kwargs)[source]

Get documents in form

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required)

Returns: SignatureFormDocumentsResponse

GetSignatureFormFields(userId, formGuid, **kwargs)[source]

Get form fields for document in form per participant

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required) fieldGuid, str: Field GUID (optional)

Returns: SignatureFormFieldsResponse

GetSignatureFormParticipant(formGuid, participantGuid, **kwargs)[source]

Get signature form participant

Args:
formGuid, str: Form GUID (required) participantGuid, str: Participant GUID (required)

Returns: SignatureFormParticipantResponse

GetSignatureFormParticipants(userId, formGuid, **kwargs)[source]

Get form participants

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required)

Returns: SignatureFormParticipantsResponse

GetSignatureFormResources(userId, statusIds, **kwargs)[source]

Get form resources

Args:
userId, str: User GUID (required) statusIds, str: Form status identifier - comma separated list (required)

Returns: SignatureFormResourcesResponse

GetSignatureForms(userId, **kwargs)[source]

Get signature forms

Args:
userId, str: User GUID (required) statusId, int: Filter forms by statusId (optional) page, int: Show records for page number (optional) records, int: Show records count (optional) originalDocumentMD5, str: Filter forms by original document MD5 (optional) datetime, str: Filter forms by date (optional) name, str: Filter forms by name (optional) tag, str: Filter forms by tag (optional)

Returns: SignatureFormsResponse

GetSignaturePredefinedLists(userId, **kwargs)[source]

Get user predefined lists

Args:
userId, str: User GUID (required)

Returns: SignaturePredefinedListsResponse

GetSignatureTemplate(userId, templateGuid, **kwargs)[source]

Get template

Args:
userId, str: User GUID (required) templateGuid, str: Template GUID (required)

Returns: SignatureTemplateResponse

GetSignatureTemplateDocuments(userId, templateGuid, **kwargs)[source]

Get documents in template

Args:
userId, str: User GUID (required) templateGuid, str: Template GUID (required)

Returns: SignatureTemplateDocumentsResponse

GetSignatureTemplateFields(userId, templateGuid, **kwargs)[source]

Get template fields

Args:
userId, str: User GUID (required) templateGuid, str: Template GUID (required) documentGuid, str: Document GUID (optional) recipientGuid, str: Recipient GUID (optional) fieldGuid, str: Field GUID (optional)

Returns: SignatureTemplateFieldsResponse

GetSignatureTemplateRecipients(userId, templateGuid, **kwargs)[source]

Get template recipients

Args:
userId, str: User GUID (required) templateGuid, str: Template GUID (required)

Returns: SignatureTemplateRecipientsResponse

GetSignatureTemplateResources(userId, **kwargs)[source]

Get template resources

Args:
userId, str: User GUID (required)

Returns: SignatureTemplateResourcesResponse

GetSignatureTemplates(userId, **kwargs)[source]

Get templates

Args:
userId, str: User GUID (required) page, int: Page number (optional) records, int: Records count (optional) documentGuid, str: Fitler templates by document originalMD5 (optional) recipientName, str: Filter templates by recipient nickname (optional) name, str: Filter templates by signatureTemplate name (optional) tag, str: Filter templates by tag (optional)

Returns: SignatureTemplatesResponse

GetSignatures(userId, **kwargs)[source]

Get user signatures

Args:
userId, str: User GUID (required) page, int: Show records for page number (optional) records, int: Show records count (optional) name, str: Filter by signature name (optional)

Returns: SignatureSignaturesResponse

GetSignedEnvelopeDocument(userId, envelopeGuid, documentGuid, **kwargs)[source]

Get signed envelope document

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) documentGuid, str: Document GUID (required)

Returns: stream

GetSignedEnvelopeDocuments(userId, envelopeGuid, **kwargs)[source]

Get signed envelope documents

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required)

Returns: stream

GetSignedFormDocuments(userId, formGuid, **kwargs)[source]

Get signed form documents

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required)

Returns: stream

GetUserEmailTemplate(userId, templateType, **kwargs)[source]

Get user email template

Args:
userId, str: User GUID (required) templateType, int: Template type (required)

Returns: stream

ImportContacts(userId, **kwargs)[source]

Import contacts

Args:
userId, str: User GUID (required) body, List[SignatureContactSettingsInfo]: Array of SignatureContactSettingsInfo (optional)

Returns: SignatureContactsImportResponse

ModifyContact(userId, contactGuid, **kwargs)[source]

Update contact

Args:
userId, str: User GUID (required) contactGuid, str: Contact GUID (required) body, SignatureContactSettingsInfo: Contact data (optional)

Returns: SignatureContactResponse

ModifySignatureEnvelope(userId, envelopeGuid, **kwargs)[source]

Modify signature envelope

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) body, SignatureEnvelopeSettingsInfo: Settings of the envelope (optional)

Returns: SignatureEnvelopeResponse

ModifySignatureEnvelopeField(userId, envelopeGuid, documentGuid, recipientGuid, fieldGuid, **kwargs)[source]

Modify signature envelope field

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) documentGuid, str: Document GUID (required) recipientGuid, str: Recipient GUID (required) fieldGuid, str: Field GUID (required) body, SignatureEnvelopeFieldSettingsInfo: Settings of the field (optional)

Returns: SignatureEnvelopeFieldResponse

ModifySignatureEnvelopeFieldLocation(userId, envelopeGuid, documentGuid, recipientGuid, fieldGuid, locationGuid, **kwargs)[source]

Modify signature envelope field location

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) documentGuid, str: Document GUID (required) recipientGuid, str: Recipient GUID (required) fieldGuid, str: Field GUID (required) locationGuid, str: Field location GUID (required) body, SignatureEnvelopeFieldLocationSettingsInfo: Settings of the field location (optional)

Returns: SignatureEnvelopeFieldResponse

ModifySignatureEnvelopeFieldLocationOrder(userId, envelopeGuid, documentGuid, recipientGuid, fieldGuid, locationGuid, **kwargs)[source]

Modify signature envelope field location

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) documentGuid, str: Document GUID (required) recipientGuid, str: Recipient GUID (required) fieldGuid, str: Field GUID (required) locationGuid, str: Field location GUID (required) order, int: Location order (optional)

Returns: SignatureEnvelopeFieldResponse

ModifySignatureEnvelopeRecipient(userId, envelopeGuid, recipientGuid, recipientEmail, recipientFirstName, recipientLastName, roleGuid, **kwargs)[source]

Modify signature envelope recipient

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) recipientGuid, str: Recipient GUID (required) recipientEmail, str: Recipient email (required) recipientFirstName, str: Recipient first name (required) recipientLastName, str: Recipient last name (required) roleGuid, str: Recipient role GUID (required) order, int: Recipient order (optional)

Returns: SignatureEnvelopeRecipientResponse

ModifySignatureField(userId, fieldGuid, **kwargs)[source]

Modify signature field

Args:
userId, str: User GUID (required) fieldGuid, str: Field GUID (required) body, SignatureFieldSettingsInfo: Settings of the field (optional)

Returns: SignatureFieldResponse

ModifySignatureForm(userId, formGuid, **kwargs)[source]

Modify signature form

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required) body, SignatureFormSettingsInfo: Settings of the form (optional)

Returns: SignatureFormResponse

ModifySignatureFormDocument(userId, formGuid, documentGuid, **kwargs)[source]

Modify signature form document

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required) documentGuid, str: Form Document GUID (required) body, SignatureFormDocumentSettingsInfo: Settings of the document (optional)

Returns: SignatureFormDocumentResponse

ModifySignatureFormField(userId, formGuid, documentGuid, fieldGuid, **kwargs)[source]

Modify signature form field

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required) documentGuid, str: Document GUID (required) fieldGuid, str: Field GUID (required) body, SignatureFormFieldSettingsInfo: Settings of the field (optional)

Returns: SignatureFormFieldResponse

ModifySignatureFormFieldLocation(userId, formGuid, documentGuid, fieldGuid, locationGuid, **kwargs)[source]

Modify signature form field location

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required) documentGuid, str: Document GUID (required) fieldGuid, str: Field GUID (required) locationGuid, str: Field location GUID (required) body, SignatureFormFieldLocationSettingsInfo: Settings of the field location (optional)

Returns: SignatureFormFieldResponse

ModifySignatureTemplate(userId, templateGuid, **kwargs)[source]

Modify template

Args:
userId, str: User GUID (required) templateGuid, str: Template GUID (required) body, SignatureTemplateSettingsInfo: Settings of the template (optional)

Returns: SignatureTemplateResponse

ModifySignatureTemplateField(userId, templateGuid, documentGuid, recipientGuid, fieldGuid, **kwargs)[source]

Modify signature template field

Args:
userId, str: User GUID (required) templateGuid, str: Template GUID (required) documentGuid, str: Document GUID (required) recipientGuid, str: Recipient GUID (required) fieldGuid, str: Field GUID (required) body, SignatureTemplateFieldSettingsInfo: Settings of the field (optional)

Returns: SignatureTemplateFieldResponse

ModifySignatureTemplateFieldLocation(userId, templateGuid, documentGuid, recipientGuid, fieldGuid, locationGuid, **kwargs)[source]

Modify signature template field location

Args:
userId, str: User GUID (required) templateGuid, str: Template GUID (required) documentGuid, str: Document GUID (required) recipientGuid, str: Recipient GUID (required) fieldGuid, str: Field GUID (required) locationGuid, str: Field location GUID (required) body, SignatureTemplateFieldLocationSettingsInfo: Settings of the field location (optional)

Returns: SignatureTemplateFieldResponse

ModifySignatureTemplateRecipient(userId, templateGuid, recipientGuid, nickname, roleGuid, **kwargs)[source]

Update template recipient

Args:
userId, str: User GUID (required) templateGuid, str: Template GUID (required) recipientGuid, str: Recipient GUID (required) nickname, str: Nickname of the recipient (required) roleGuid, str: Role GUID (required) order, str: Display order of the recipient (optional)

Returns: SignatureTemplateRecipientResponse

PublicFillEnvelopeField(envelopeGuid, documentGuid, recipientGuid, fieldGuid, **kwargs)[source]

Fill envelope field

Args:
envelopeGuid, str: Envelope GUID (required) documentGuid, str: Document GUID (required) recipientGuid, str: Recipient GUID (required) fieldGuid, str: Field GUID (required) body, stream: Data to be placed in field (optional)

Returns: SignatureEnvelopeFieldResponse

PublicFillFormField(formGuid, documentGuid, fieldGuid, authSignature, participantIdId, **kwargs)[source]

Fill form field

Args:
formGuid, str: Form GUID (required) documentGuid, str: Document GUID (required) fieldGuid, str: Field GUID (required) authSignature, str: Authentication signature (required) body, stream: Data to be placed in field (optional) participantIdId, str: Participant GUID (required)

Returns: SignatureFormFieldResponse

PublicFillSignatureForm(formGuid, **kwargs)[source]

Fill signature form

Args:
formGuid, str: Form GUID (required)

Returns: SignatureFormParticipantResponse

PublicFormParticipantResentValidationCode(formGuid, participantGuid, **kwargs)[source]

Request validation code email

Args:
formGuid, str: Form GUID (required) participantGuid, str: Participant GUID (required)

Returns: SignatureStatusResponse

PublicGetDefaultEmailTemplate(templateType, **kwargs)[source]

Get default email template

Args:
templateType, int: Template type (required)

Returns: stream

PublicGetDocumentFields(documentGuid, **kwargs)[source]

Sign document

Args:
documentGuid, str: Document GUID (required)

Returns: SignatureDocumentFieldsResponse

PublicGetEnvelopeDocuments(envelopeGuid, recipientGuid, **kwargs)[source]

Get documents in envelope

Args:
envelopeGuid, str: Envelope GUID (required) recipientGuid, str: Recipient GUID (required)

Returns: SignatureEnvelopeDocumentsResponse

PublicGetEnvelopeRecipients(envelopeGuid, **kwargs)[source]

Get signature envelope recipients

Args:
envelopeGuid, str: Envelope GUID (required)

Returns: SignatureEnvelopeRecipientsResponse

PublicGetSignDocumentStatus(jobGuid, **kwargs)[source]

Get signed document status

Args:
jobGuid, str: Job GUID (required)

Returns: SignatureSignDocumentStatusResponse

PublicGetSignatureEnvelope(envelopeGuid, recipientGuid, **kwargs)[source]

Get signature envelope

Args:
envelopeGuid, str: Envelope GUID (required) recipientGuid, str: Recipient GUID (required)

Returns: SignatureEnvelopeResponse

PublicGetSignatureEnvelopeFields(envelopeGuid, documentGuid, recipientGuid, **kwargs)[source]

Get signature field for document in envelope per recipient

Args:
envelopeGuid, str: Envelope GUID (required) documentGuid, str: Document GUID (required) recipientGuid, str: Recipient GUID (required)

Returns: SignatureEnvelopeFieldsResponse

PublicGetSignatureForm(formGuid, **kwargs)[source]

Get signature form

Args:
formGuid, str: Form GUID (required)

Returns: SignatureFormResponse

PublicGetSignatureFormDocuments(formGuid, **kwargs)[source]

Get documents in form

Args:
formGuid, str: Form GUID (required)

Returns: SignatureFormDocumentsResponse

PublicGetSignatureFormFields(formGuid, documentGuid, participantGuid, **kwargs)[source]

Get form fields for document in form per participant

Args:
formGuid, str: Form GUID (required) documentGuid, str: Document GUID (required) participantGuid, str: Participant GUID (required)

Returns: SignatureFormFieldsResponse

PublicGetSignedEnvelopeDocuments(envelopeGuid, recipientGuid, **kwargs)[source]

Get signed envelope documents

Args:
envelopeGuid, str: Envelope GUID (required) recipientGuid, str: Recipient GUID (required)

Returns: stream

PublicGetSignedFormDocuments(formGuid, participantGuid, **kwargs)[source]

Get signed form documents

Args:
formGuid, str: Form GUID (required) participantGuid, str: Participant GUID (required)

Returns: stream

PublicModifyFormParticipant(formGuid, participantGuid, participantEmail, **kwargs)[source]

Update Form Participant

Args:
formGuid, str: Form GUID (required) participantGuid, str: Participant GUID (required) participantEmail, str: Participant Email to be set (required)

Returns: SignatureFormParticipantResponse

PublicSignDocument(documentGuid, **kwargs)[source]

Sign document

Args:
documentGuid, str: Document GUID (required) body, PublicSignatureSignDocumentSignerSettingsInfo: Settings of the signing document (optional)

Returns: SignatureSignDocumentResponse

PublicSignEnvelope(envelopeGuid, recipientGuid, **kwargs)[source]

Sign envelope

Args:
envelopeGuid, str: Envelope GUID (required) recipientGuid, str: Recipient GUID (required) body, SignatureSignEnvelopeSettingsInfo: Sign settings (optional)

Returns: SignatureStatusResponse

PublicSignForm(formGuid, participantGuid, participantName, authSignature, **kwargs)[source]

Sign Form

Args:
formGuid, str: Form GUID (required) participantGuid, str: Participant GUID (required) participantName, str: Participant Name (required) authSignature, str: Authentication signature (required) authData, stream: Base64 encoded Signer Image (optional) body, SignatureSignFormSettingsInfo: Sign settings (optional)

Returns: SignatureStatusResponse

PublicValidateFormParticipant(formGuid, participantGuid, validationCode, **kwargs)[source]

Validate Particpiant Identity

Args:
formGuid, str: Form GUID (required) participantGuid, str: Participant GUID (required) validationCode, str: Code to be validated (required)

Returns: SignatureStatusResponse

PublicVerifyDocument(body, **kwargs)[source]

Verify

Args:
body, stream: Document to verify (required)

Returns: SignatureVerifyDocumentResponse

PublishSignatureForm(userId, formGuid, **kwargs)[source]

Publish signature form

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required) body, WebhookInfo: Webhook Callback Url (optional)

Returns: SignatureStatusResponse

RenameSignatureEnvelope(userId, envelopeGuid, name, **kwargs)[source]

Rename signature envelope

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) name, str: New envelope name (required)

Returns: SignatureEnvelopeResponse

RenameSignatureEnvelopeDocument(userId, envelopeGuid, documentGuid, **kwargs)[source]

Rename signature envelope document

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) documentGuid, str: Document GUID (required) newName, str: New name of the document (optional)

Returns: SignatureEnvelopeDocumentResponse

RenameSignatureForm(userId, formGuid, name, **kwargs)[source]

Rename signature form

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required) name, str: New form name (required)

Returns: SignatureFormResponse

RenameSignatureFormDocument(userId, formGuid, documentGuid, **kwargs)[source]

Rename signature form document

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required) documentGuid, str: Form Document GUID (required) newName, str: New name of the document (optional)

Returns: SignatureFormDocumentResponse

RenameSignatureTemplate(userId, templateGuid, name, **kwargs)[source]

Rename template

Args:
userId, str: User GUID (required) templateGuid, str: Template GUID (required) name, str: New template name (required)

Returns: SignatureTemplateResponse

RenameSignatureTemplateDocument(userId, templateGuid, documentGuid, **kwargs)[source]

Rename signature template document

Args:
userId, str: User GUID (required) templateGuid, str: Template GUID (required) documentGuid, str: Template Document GUID (required) newName, str: New name of the document (optional)

Returns: SignatureTemplateDocumentResponse

ResendSignatureEnvelopeEmailNotification(userId, envelopeGuid, **kwargs)[source]

Resend envelope email notification

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required)

Returns: SignatureStatusResponse

RestartExpiredSignatureEnvelope(userId, envelopeGuid, **kwargs)[source]

Restart expired envelope

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required)

Returns: SignatureStatusResponse

RetrySignEnvelope(userId, envelopeGuid, **kwargs)[source]

Retry sign envelope

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required)

Returns: SignatureStatusResponse

SignDocument(userId, **kwargs)[source]

Sign document

Args:
userId, str: User GUID (required) body, SignatureSignDocumentSettingsInfo: Settings of the signing document (optional)

Returns: SignatureSignDocumentResponse

SignEnvelope(userId, envelopeGuid, recipientGuid, **kwargs)[source]

Sign envelope

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) recipientGuid, str: Recipient GUID (required) body, SignatureSignEnvelopeSettingsInfo: Sign settings (optional)

Returns: SignatureStatusResponse

SignatureEnvelopeSend(userId, envelopeGuid, **kwargs)[source]

Send envelope

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) body, WebhookInfo: Webhook Callback Url (optional)

Returns: SignatureEnvelopeSendResponse

UpdateEnvelopeFromTemplate(userId, envelopeGuid, templateGuid, **kwargs)[source]

Update envelope from template

Args:
userId, str: User GUID (required) envelopeGuid, str: Envelope GUID (required) templateGuid, str: Template GUID (required)

Returns: SignatureEnvelopeResponse

UpdateSignatureFormFromTemplate(userId, formGuid, templateGuid, **kwargs)[source]

Add signature form fields from template

Args:
userId, str: User GUID (required) formGuid, str: Form GUID (required) templateGuid, str: Template GUID (required)

Returns: SignatureFormResponse

basePath

StorageApi Module

class groupdocs.StorageApi.StorageApi(apiClient)[source]

Bases: object

CancelFileUpload(userId, fileId, filePath, **kwargs)[source]

Cancel file upload

Args:
userId, str: User GUID (optional) fileId, str: file Id (optional) filePath, str: File path (optional)

Returns: CancelFileUploadResponse

Compress(userId, fileId, archiveType, **kwargs)[source]
Args:
userId, str: User GUID (required) fileId, str: File ID (required) archiveType, str: Archive type (optional)

Returns: CompressResponse

Create(userId, path, **kwargs)[source]
Args:
userId, str: User GUID (required) path, str: Path (required)

Returns: CreateFolderResponse

CreatePackage(userId, packageName, **kwargs)[source]

Create Package

Args:
userId, str: User GUID (required) packageName, str: Package Name (required) storeRelativePath, bool: Store files using relative paths (optional) body, List[str]: Paths (optional)

Returns: CreatePackageResponse

Decompress(userId, path, body, **kwargs)[source]

UploadAndUnzip

Args:
userId, str: User GUID (required) path, str: Path (required) description, str: Description (optional) archiveType, str: Archive type (optional) body, stream: Stream (required)

Returns: UploadResponse

Delete(userId, fileId, **kwargs)[source]
Args:
userId, str: User GUID (required) fileId, str: File ID (required)

Returns: DeleteResponse

DeleteFromFolder(userId, path, **kwargs)[source]

Delete from folder

Args:
userId, str: User GUID (required) path, str: Path (required)

Returns: DeleteResponse

GetFile(userId, fileId, **kwargs)[source]

Get file

Args:
userId, str: User GUID (required) fileId, str: File GUID (required)

Returns: stream

GetSharedFile(userEmail, filePath, **kwargs)[source]

Get shared file

Args:
userEmail, str: User Email (required) filePath, str: File path (required)

Returns: stream

GetStorageInfo(userId, **kwargs)[source]

Get storage info

Args:
userId, str: User GUID (required)

Returns: StorageInfoResponse

ListEntities(userId, path, **kwargs)[source]

List entities

Args:
userId, str: User GUID (required) path, str: Path (optional) pageIndex, int: Page Index (optional) pageSize, int: Page Size (optional) orderBy, str: Order By (optional) orderAsc, bool: Order Asc (optional) filter, str: Filter (optional) fileTypes, str: File Types (optional) extended, bool: Indicates whether an extended information should be returned (optional)

Returns: ListEntitiesResponse

MoveFile(userId, path, **kwargs)[source]

Move file

Args:
userId, str: User GUID (required) path, str: Path (required) mode, str: Mode (optional) Groupdocs_Move, str: File ID (move) (optional) Groupdocs_Copy, str: File ID (copy) (optional)

Returns: FileMoveResponse

MoveFolder(userId, path, **kwargs)[source]

Move folder

Args:
userId, str: User GUID (required) path, str: Destination Path (required) mode, str: Mode (optional) Groupdocs_Move, str: Source path (move) (optional) Groupdocs_Copy, str: Source path (copy) (optional)

Returns: FolderMoveResponse

MoveToTrash(userId, path, **kwargs)[source]

Move to trash

Args:
userId, str: User GUID (required) path, str: Path (required)

Returns: DeleteResponse

RestoreFromTrash(userId, path, **kwargs)[source]

Restore from trash

Args:
userId, str: User GUID (required) path, str: Path (required)

Returns: DeleteResponse

Upload(userId, path, body, **kwargs)[source]
Args:
userId, str: User GUID (required) path, str: Path (required) description, str: Description (optional) callbackUrl, str: Callback url (optional) overrideMode, int: Override mode (optional) body, stream: Stream (required)

Returns: UploadResponse

UploadGoogle(userId, path, **kwargs)[source]

Upload Google

Args:
userId, str: User GUID (required) path, str: File path (required) fileId, str: File unique identifier (optional)

Returns: UploadResponse

UploadWeb(userId, url, **kwargs)[source]

Upload Web

Args:
userId, str: User GUID (required) url, str: Url (required)

Returns: UploadResponse

basePath

SystemApi Module

class groupdocs.SystemApi.SystemApi(apiClient)[source]

Bases: object

GetCountries(callerId, **kwargs)[source]

Get countries

Args:
callerId, str: User GUID (required)

Returns: GetCountriesResponse

GetInvoices(callerId, **kwargs)[source]

Get invoices

Args:
callerId, str: User GUID (required) pageNumber, str: Show records for page number (optional) pageSize, int: Show records count (optional)

Returns: GetInvoicesResponse

GetPurchseWizardInfo(userId, **kwargs)[source]

Returns purchase wizard info from billing provider

Args:
userId, str: User global unique identifier (required)

Returns: GetPurchaseWizardResponse

GetStates(callerId, countryName, **kwargs)[source]

Get states

Args:
callerId, str: User GUID (required) countryName, str: Country Name (required)

Returns: GetStatesResponse

GetSubscriptionPlanUsage(userId, **kwargs)[source]

Get subscription plans

Args:
userId, str: User GUID (required)

Returns: GetSubscriptionPlanUsageResponse

GetSubscriptionPlans(callerId, family, **kwargs)[source]

Get subscription plans

Args:
callerId, str: User GUID (required) family, str: Product Family Name (required)

Returns: GetSubscriptionPlansResponse

GetTermSuggestions(userId, term, **kwargs)[source]

Returns suggestions for a specified term

Args:
userId, str: User global unique identifier (required) term, str: A term to return suggestions for (required)

Returns: GetTermSuggestionsResponse

GetUserPlan(callerId, **kwargs)[source]

Get user plan

Args:
callerId, str: User GUID (required)

Returns: GetPlanResponse

GetUserSubscriptionPlan(callerId, **kwargs)[source]

Get user plan

Args:
callerId, str: User GUID (required)

Returns: GetUserSubscriptionPlanResponse

SetBillingAddress(userId, body, **kwargs)[source]

Set user billing address

Args:
userId, str: User GUID (required) body, BillingAddressInfo: Billing Address (required)

Returns: GetBillingAddressResponse

SetSubscriptionPlan(userId, productId, body, **kwargs)[source]

Set subscription plan user plan

Args:
userId, str: User GUID (required) productId, str: Product ID (required) body, SubscriptionPlanInfo: Subscription Plan (required)

Returns: SetUserSubscriptionPlanResponse

SimulateAssessForPaymentPlan(userId, discountCode, paymentPlanId, **kwargs)[source]

Simulate Assess For Payment Plan

Args:
userId, str: User GUID (required) discountCode, str: Discount Code (optional) paymentPlanId, str: Payment PlanId on the payment service (optional)

Returns: GetInvoicesResponse

SimulateAssessForPricingPlan(userId, discountCode, planId, **kwargs)[source]

Simulate Assess For Pricing Plan

Args:
userId, str: User GUID (required) discountCode, str: Discount Code (optional) planId, str: Subscription Plan Id (optional)

Returns: GetInvoicesResponse

UpdateSubscriptionPlan(userId, productId, body, **kwargs)[source]

Update subscription plan user plan

Args:
userId, str: User GUID (required) productId, str: Product ID (required) body, UpdateSubscriptionPlanInfo: Subscripition Plan Update parameters (required)

Returns: SetUserSubscriptionPlanResponse

basePath