boldsign 1.0.1 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (233) hide show
  1. package/.openapi-generator/FILES +2 -0
  2. package/README.md +2 -0
  3. package/api/apis.ts +1 -1
  4. package/dist/api/apis.d.ts +1 -1
  5. package/dist/api/apis.js +1 -1
  6. package/dist/model/accessCodeDetail.d.ts +2 -0
  7. package/dist/model/accessCodeDetail.js +5 -0
  8. package/dist/model/accessCodeDetail.js.map +1 -1
  9. package/dist/model/authenticationSettings.d.ts +22 -0
  10. package/dist/model/authenticationSettings.js +27 -0
  11. package/dist/model/authenticationSettings.js.map +1 -0
  12. package/dist/model/documentSigner.d.ts +2 -0
  13. package/dist/model/documentSigner.js +5 -0
  14. package/dist/model/documentSigner.js.map +1 -1
  15. package/dist/model/documentSignerDetails.d.ts +2 -0
  16. package/dist/model/documentSignerDetails.js +5 -0
  17. package/dist/model/documentSignerDetails.js.map +1 -1
  18. package/dist/model/index.d.ts +3 -1
  19. package/dist/model/index.js +10 -3
  20. package/dist/model/index.js.map +1 -1
  21. package/dist/model/role.d.ts +2 -0
  22. package/dist/model/role.js +5 -0
  23. package/dist/model/role.js.map +1 -1
  24. package/dist/model/signerAuthenticationSettings.d.ts +15 -0
  25. package/dist/model/signerAuthenticationSettings.js +23 -0
  26. package/dist/model/signerAuthenticationSettings.js.map +1 -0
  27. package/dist/tests/config.d.ts +5 -0
  28. package/dist/tests/config.js +43 -0
  29. package/dist/tests/config.js.map +1 -0
  30. package/dist/tests/integration/BrandingApiTest.spec.d.ts +1 -0
  31. package/dist/tests/integration/BrandingApiTest.spec.js +310 -0
  32. package/dist/tests/integration/BrandingApiTest.spec.js.map +1 -0
  33. package/dist/tests/integration/ContactsApiTest.spec.d.ts +1 -0
  34. package/dist/tests/integration/ContactsApiTest.spec.js +249 -0
  35. package/dist/tests/integration/ContactsApiTest.spec.js.map +1 -0
  36. package/dist/tests/integration/CustomFieldApiTest.spec.d.ts +1 -0
  37. package/dist/tests/integration/CustomFieldApiTest.spec.js +289 -0
  38. package/dist/tests/integration/CustomFieldApiTest.spec.js.map +1 -0
  39. package/dist/tests/integration/DocumentApiTest.spec.d.ts +1 -0
  40. package/dist/tests/integration/DocumentApiTest.spec.js +1691 -0
  41. package/dist/tests/integration/DocumentApiTest.spec.js.map +1 -0
  42. package/dist/tests/integration/TemplateApiTest.spec.d.ts +1 -0
  43. package/dist/tests/integration/TemplateApiTest.spec.js +1440 -0
  44. package/dist/tests/integration/TemplateApiTest.spec.js.map +1 -0
  45. package/dist/tests/integration/planApiTest.spec.d.ts +1 -0
  46. package/dist/tests/integration/planApiTest.spec.js +41 -0
  47. package/dist/tests/integration/planApiTest.spec.js.map +1 -0
  48. package/dist/tests/integration/senderIdentity.spec.d.ts +1 -0
  49. package/dist/tests/integration/senderIdentity.spec.js +481 -0
  50. package/dist/tests/integration/senderIdentity.spec.js.map +1 -0
  51. package/dist/tests/integration/teamsApiTest.spec.d.ts +1 -0
  52. package/dist/tests/integration/teamsApiTest.spec.js +230 -0
  53. package/dist/tests/integration/teamsApiTest.spec.js.map +1 -0
  54. package/dist/tests/integration/usersApiTest.spec.d.ts +1 -0
  55. package/dist/tests/integration/usersApiTest.spec.js +290 -0
  56. package/dist/tests/integration/usersApiTest.spec.js.map +1 -0
  57. package/dist/tests/unit/brandingApi.spec.d.ts +1 -0
  58. package/dist/tests/unit/brandingApi.spec.js +174 -0
  59. package/dist/tests/unit/brandingApi.spec.js.map +1 -0
  60. package/dist/tests/unit/contactsApi.spec.d.ts +1 -0
  61. package/dist/tests/unit/contactsApi.spec.js +154 -0
  62. package/dist/tests/unit/contactsApi.spec.js.map +1 -0
  63. package/dist/tests/unit/customFieldApi.spec.d.ts +1 -0
  64. package/dist/tests/unit/customFieldApi.spec.js +140 -0
  65. package/dist/tests/unit/customFieldApi.spec.js.map +1 -0
  66. package/dist/tests/unit/documentApi.spec.d.ts +1 -0
  67. package/dist/tests/unit/documentApi.spec.js +476 -0
  68. package/dist/tests/unit/documentApi.spec.js.map +1 -0
  69. package/dist/tests/unit/planApi.spec.d.ts +1 -0
  70. package/dist/tests/unit/planApi.spec.js +69 -0
  71. package/dist/tests/unit/planApi.spec.js.map +1 -0
  72. package/dist/tests/unit/senderIdentitiesApi.spec.d.ts +1 -0
  73. package/dist/tests/unit/senderIdentitiesApi.spec.js +148 -0
  74. package/dist/tests/unit/senderIdentitiesApi.spec.js.map +1 -0
  75. package/dist/tests/unit/teamApi.spec.d.ts +1 -0
  76. package/dist/tests/unit/teamApi.spec.js +116 -0
  77. package/dist/tests/unit/teamApi.spec.js.map +1 -0
  78. package/dist/tests/unit/templateApi.spec.d.ts +1 -0
  79. package/dist/tests/unit/templateApi.spec.js +285 -0
  80. package/dist/tests/unit/templateApi.spec.js.map +1 -0
  81. package/dist/tests/unit/userApi.spec.d.ts +1 -0
  82. package/dist/tests/unit/userApi.spec.js +163 -0
  83. package/dist/tests/unit/userApi.spec.js.map +1 -0
  84. package/docs/AccessCodeDetail.md +19 -0
  85. package/docs/AccessCodeDetails.md +13 -0
  86. package/docs/Address.md +16 -0
  87. package/docs/AttachmentInfo.md +14 -0
  88. package/docs/AuditTrail.md +18 -0
  89. package/docs/AuthenticationSettings.md +11 -0
  90. package/docs/Base64File.md +12 -0
  91. package/docs/BehalfDocument.md +27 -0
  92. package/docs/BehalfDocumentRecords.md +12 -0
  93. package/docs/BehalfOf.md +12 -0
  94. package/docs/BillingViewModel.md +11 -0
  95. package/docs/BrandCreated.md +11 -0
  96. package/docs/BrandCustomFieldDetails.md +16 -0
  97. package/docs/BrandingApi.md +258 -0
  98. package/docs/BrandingMessage.md +11 -0
  99. package/docs/BrandingRecords.md +11 -0
  100. package/docs/ChangeRecipient.md +18 -0
  101. package/docs/ConditionalRule.md +13 -0
  102. package/docs/ContactCreated.md +12 -0
  103. package/docs/ContactDetails.md +15 -0
  104. package/docs/ContactPageDetails.md +13 -0
  105. package/docs/ContactsApi.md +176 -0
  106. package/docs/ContactsDetails.md +16 -0
  107. package/docs/ContactsList.md +12 -0
  108. package/docs/CreateContactResponse.md +11 -0
  109. package/docs/CreateSenderIdentityRequest.md +16 -0
  110. package/docs/CreateTeamRequest.md +11 -0
  111. package/docs/CreateTemplateRequest.md +35 -0
  112. package/docs/CreateUser.md +14 -0
  113. package/docs/CustomDomainSettings.md +12 -0
  114. package/docs/CustomFieldApi.md +174 -0
  115. package/docs/CustomFieldCollection.md +11 -0
  116. package/docs/CustomFieldMessage.md +12 -0
  117. package/docs/CustomFormField.md +43 -0
  118. package/docs/Date.md +13 -0
  119. package/docs/DeleteCustomFieldReply.md +11 -0
  120. package/docs/Document.md +26 -0
  121. package/docs/DocumentApi.md +756 -0
  122. package/docs/DocumentCC.md +11 -0
  123. package/docs/DocumentCcDetails.md +12 -0
  124. package/docs/DocumentCreated.md +11 -0
  125. package/docs/DocumentExpirySettings.md +16 -0
  126. package/docs/DocumentFiles.md +13 -0
  127. package/docs/DocumentFormFields.md +49 -0
  128. package/docs/DocumentInfo.md +14 -0
  129. package/docs/DocumentProperties.md +50 -0
  130. package/docs/DocumentReassign.md +13 -0
  131. package/docs/DocumentRecords.md +12 -0
  132. package/docs/DocumentSenderDetail.md +14 -0
  133. package/docs/DocumentSigner.md +31 -0
  134. package/docs/DocumentSignerDetails.md +37 -0
  135. package/docs/DocumentTags.md +12 -0
  136. package/docs/DownloadImageRequest.md +16 -0
  137. package/docs/EditSenderIdentityRequest.md +14 -0
  138. package/docs/EditTemplateRequest.md +29 -0
  139. package/docs/EditableDateFieldSettings.md +13 -0
  140. package/docs/EmbeddedCreateTemplateRequest.md +46 -0
  141. package/docs/EmbeddedCustomFieldCreated.md +11 -0
  142. package/docs/EmbeddedDocumentRequest.md +55 -0
  143. package/docs/EmbeddedFileDetails.md +16 -0
  144. package/docs/EmbeddedFileLink.md +11 -0
  145. package/docs/EmbeddedMergeTemplateFormRequest.md +56 -0
  146. package/docs/EmbeddedSendCreated.md +12 -0
  147. package/docs/EmbeddedSendTemplateFormRequest.md +53 -0
  148. package/docs/EmbeddedSigningLink.md +11 -0
  149. package/docs/EmbeddedTemplateCreated.md +12 -0
  150. package/docs/EmbeddedTemplateEditRequest.md +21 -0
  151. package/docs/EmbeddedTemplateEdited.md +11 -0
  152. package/docs/Error.md +12 -0
  153. package/docs/ErrorResult.md +11 -0
  154. package/docs/ExistingFormField.md +15 -0
  155. package/docs/ExtendExpiry.md +14 -0
  156. package/docs/FileInfo.md +14 -0
  157. package/docs/Font.md +18 -0
  158. package/docs/FormField.md +50 -0
  159. package/docs/FormGroup.md +15 -0
  160. package/docs/FormulaFieldSettings.md +12 -0
  161. package/docs/IdDocument.md +21 -0
  162. package/docs/IdReport.md +14 -0
  163. package/docs/IdVerification.md +18 -0
  164. package/docs/IdentityVerificationApi.md +109 -0
  165. package/docs/IdentityVerificationSettings.md +16 -0
  166. package/docs/ImageInfo.md +13 -0
  167. package/docs/MergeAndSendForSignForm.md +46 -0
  168. package/docs/NotificationSettings.md +22 -0
  169. package/docs/PageDetails.md +16 -0
  170. package/docs/PhoneNumber.md +12 -0
  171. package/docs/PlanApi.md +38 -0
  172. package/docs/PrefillField.md +12 -0
  173. package/docs/PrefillFieldRequest.md +12 -0
  174. package/docs/ProblemDetails.md +15 -0
  175. package/docs/RecipientNotificationSettings.md +22 -0
  176. package/docs/Rectangle.md +14 -0
  177. package/docs/ReminderMessage.md +13 -0
  178. package/docs/ReminderSettings.md +13 -0
  179. package/docs/RemoveAuthentication.md +14 -0
  180. package/docs/RevokeDocument.md +12 -0
  181. package/docs/Role.md +33 -0
  182. package/docs/Roles.md +33 -0
  183. package/docs/SendForSign.md +45 -0
  184. package/docs/SendForSignFromTemplateForm.md +43 -0
  185. package/docs/SenderIdentitiesApi.md +209 -0
  186. package/docs/SenderIdentityCreated.md +11 -0
  187. package/docs/SenderIdentityList.md +12 -0
  188. package/docs/SenderIdentityViewModel.md +19 -0
  189. package/docs/SignerAuthenticationSettings.md +12 -0
  190. package/docs/Size.md +12 -0
  191. package/docs/TeamCreated.md +11 -0
  192. package/docs/TeamDocumentRecords.md +12 -0
  193. package/docs/TeamListResponse.md +12 -0
  194. package/docs/TeamPageDetails.md +12 -0
  195. package/docs/TeamResponse.md +15 -0
  196. package/docs/TeamUpdateRequest.md +12 -0
  197. package/docs/TeamUsers.md +16 -0
  198. package/docs/Teams.md +14 -0
  199. package/docs/TeamsApi.md +141 -0
  200. package/docs/Template.md +29 -0
  201. package/docs/TemplateApi.md +484 -0
  202. package/docs/TemplateCC.md +12 -0
  203. package/docs/TemplateCreated.md +11 -0
  204. package/docs/TemplateFormFields.md +50 -0
  205. package/docs/TemplateProperties.md +37 -0
  206. package/docs/TemplateRecords.md +12 -0
  207. package/docs/TemplateRole.md +28 -0
  208. package/docs/TemplateSenderDetail.md +12 -0
  209. package/docs/TemplateSenderDetails.md +13 -0
  210. package/docs/TemplateSharedTemplateDetail.md +12 -0
  211. package/docs/TemplateSignerDetails.md +27 -0
  212. package/docs/TemplateTag.md +14 -0
  213. package/docs/TextTagDefinition.md +40 -0
  214. package/docs/TextTagOffset.md +12 -0
  215. package/docs/UpdateUser.md +14 -0
  216. package/docs/UpdateUserMetaData.md +12 -0
  217. package/docs/UserApi.md +240 -0
  218. package/docs/UserPageDetails.md +12 -0
  219. package/docs/UserProperties.md +21 -0
  220. package/docs/UserRecords.md +12 -0
  221. package/docs/UsersDetails.md +21 -0
  222. package/docs/Validation.md +13 -0
  223. package/docs/VerificationDataRequest.md +15 -0
  224. package/docs/ViewBrandDetails.md +34 -0
  225. package/docs/ViewCustomFieldDetails.md +17 -0
  226. package/model/accessCodeDetail.ts +7 -0
  227. package/model/authenticationSettings.ts +39 -0
  228. package/model/documentSigner.ts +7 -0
  229. package/model/documentSignerDetails.ts +7 -0
  230. package/model/index.ts +7 -0
  231. package/model/role.ts +7 -0
  232. package/model/signerAuthenticationSettings.ts +37 -0
  233. package/package.json +2 -1
@@ -0,0 +1,756 @@
1
+ # DocumentApi
2
+
3
+ All URIs are relative to https://api.boldsign.com.
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------------- | ------------- | ------------- |
7
+ | [**addAuthentication()**](DocumentApi.md#addAuthentication) | **PATCH** /v1/document/addAuthentication | The add authentication to recipient. |
8
+ | [**addTag()**](DocumentApi.md#addTag) | **PATCH** /v1/document/addTags | Add the Tags in Documents. |
9
+ | [**behalfDocuments()**](DocumentApi.md#behalfDocuments) | **GET** /v1/document/behalfList | Gets the behalf documents. |
10
+ | [**changeAccessCode()**](DocumentApi.md#changeAccessCode) | **PATCH** /v1/document/changeAccessCode | Changes the access code for the given document signer. |
11
+ | [**changeRecipient()**](DocumentApi.md#changeRecipient) | **PATCH** /v1/document/changeRecipient | Change recipient details of a document. |
12
+ | [**createEmbeddedRequestUrlDocument()**](DocumentApi.md#createEmbeddedRequestUrlDocument) | **POST** /v1/document/createEmbeddedRequestUrl | Generates a send URL which embeds document sending process into your application. |
13
+ | [**deleteDocument()**](DocumentApi.md#deleteDocument) | **DELETE** /v1/document/delete | Delete the document. |
14
+ | [**deleteTag()**](DocumentApi.md#deleteTag) | **DELETE** /v1/document/deleteTags | Delete the Tags in Documents. |
15
+ | [**downloadAttachment()**](DocumentApi.md#downloadAttachment) | **GET** /v1/document/downloadAttachment | Download the Attachment. |
16
+ | [**downloadAuditLog()**](DocumentApi.md#downloadAuditLog) | **GET** /v1/document/downloadAuditLog | Download the audit trail document. |
17
+ | [**downloadDocument()**](DocumentApi.md#downloadDocument) | **GET** /v1/document/download | Download the document. |
18
+ | [**extendExpiry()**](DocumentApi.md#extendExpiry) | **PATCH** /v1/document/extendExpiry | Extends the expiration date of the document. |
19
+ | [**getProperties()**](DocumentApi.md#getProperties) | **GET** /v1/document/properties | Get summary of the document. |
20
+ | [**getEmbeddedSignLink()**](DocumentApi.md#getEmbeddedSignLink) | **GET** /v1/document/getEmbeddedSignLink | Get sign link for Embedded Sign. |
21
+ | [**listDocuments()**](DocumentApi.md#listDocuments) | **GET** /v1/document/list | List user documents. |
22
+ | [**prefillFields()**](DocumentApi.md#prefillFields) | **PATCH** /v1/document/prefillFields | Updates the value (prefill) of the fields in the document. |
23
+ | [**remindDocument()**](DocumentApi.md#remindDocument) | **POST** /v1/document/remind | Send reminder to pending signers. |
24
+ | [**removeAuthentication()**](DocumentApi.md#removeAuthentication) | **PATCH** /v1/document/RemoveAuthentication | Remove the access code for the given document signer. |
25
+ | [**revokeDocument()**](DocumentApi.md#revokeDocument) | **POST** /v1/document/revoke | Revoke the document. |
26
+ | [**sendDocument()**](DocumentApi.md#sendDocument) | **POST** /v1/document/send | Sends the document for sign. |
27
+ | [**teamDocuments()**](DocumentApi.md#teamDocuments) | **GET** /v1/document/teamlist | Get user Team documents. |
28
+
29
+
30
+ ## `addAuthentication()`
31
+
32
+ ```typescript
33
+ addAuthentication(documentId: string, accessCodeDetail: AccessCodeDetail)
34
+ ```
35
+
36
+ The add authentication to recipient.
37
+
38
+
39
+ ### Parameters
40
+
41
+ |Name | Type | Description | Notes |
42
+ | ------------- | ------------- | ------------- | ------------- |
43
+ | **documentId** | **string**| The DocumentId. | |
44
+ | **accessCodeDetail** | [**AccessCodeDetail**](../docs/AccessCodeDetail.md)| Access code details. | [optional] |
45
+
46
+ ### Return type
47
+
48
+ void (empty response body)
49
+
50
+ ### Authorization
51
+
52
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
53
+
54
+ ### HTTP request headers
55
+
56
+ - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
57
+ - **Accept**: `application/json`
58
+
59
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
60
+ [[Back to Model list]](../README.md#models)
61
+ [[Back to README]](../README.md)
62
+
63
+ ## `addTag()`
64
+
65
+ ```typescript
66
+ addTag(documentTags: DocumentTags)
67
+ ```
68
+
69
+ Add the Tags in Documents.
70
+
71
+
72
+ ### Parameters
73
+
74
+ |Name | Type | Description | Notes |
75
+ | ------------- | ------------- | ------------- | ------------- |
76
+ | **documentTags** | [**DocumentTags**](../docs/DocumentTags.md)| Contains DocumentId and LabelNames for Adding Tags. | [optional] |
77
+
78
+ ### Return type
79
+
80
+ void (empty response body)
81
+
82
+ ### Authorization
83
+
84
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
85
+
86
+ ### HTTP request headers
87
+
88
+ - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
89
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
90
+
91
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
92
+ [[Back to Model list]](../README.md#models)
93
+ [[Back to README]](../README.md)
94
+
95
+ ## `behalfDocuments()`
96
+
97
+ ```typescript
98
+ behalfDocuments(page: number, pageType: 'BehalfOfOthers' | 'BehalfOfMe', emailAddress: Array<string>, signers: Array<string>, pageSize: number, startDate: Date, status: Array<'None' | 'WaitingForMe' | 'WaitingForOthers' | 'NeedAttention' | 'Completed' | 'Declined' | 'Revoked' | 'Expired' | 'Draft' | 'Scheduled'>, endDate: Date, searchKey: string, labels: Array<string>, nextCursor: number, brandIds: Array<string>): BehalfDocumentRecords
99
+ ```
100
+
101
+ Gets the behalf documents.
102
+
103
+
104
+ ### Parameters
105
+
106
+ |Name | Type | Description | Notes |
107
+ | ------------- | ------------- | ------------- | ------------- |
108
+ | **page** | **number**| Page index specified in get document list request. | [default to 1] |
109
+ | **pageType** | **'BehalfOfOthers' | 'BehalfOfMe'**| The filter used to differentiate between documents sent on the user\&#39;s behalf and documents sent by the user on behalf of others. The API will return documents based on the specified value. | [optional] |
110
+ | **emailAddress** | [**Array<string>**](../docs/string.md)| The sender identity\&#39;s email used to filter the documents returned in the API. The API will return documents that were sent on behalf of the specified email address. | [optional] |
111
+ | **signers** | [**Array<string>**](../docs/string.md)| A list of signer email addresses used to filter the documents returned in the API. The API will return documents where the signer\&#39;s email address matches one of the email addresses provided in this list | [optional] |
112
+ | **pageSize** | **number**| Page size specified in get document list request. | [optional] [default to 10] |
113
+ | **startDate** | **Date**| Start date of the document | [optional] |
114
+ | **status** | [**Array<'None' | 'WaitingForMe' | 'WaitingForOthers' | 'NeedAttention' | 'Completed' | 'Declined' | 'Revoked' | 'Expired' | 'Draft' | 'Scheduled'>**](../docs/string.md)| Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. | [optional] |
115
+ | **endDate** | **Date**| End date of the document | [optional] |
116
+ | **searchKey** | **string**| Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., | [optional] |
117
+ | **labels** | [**Array<string>**](../docs/string.md)| Labels of the document. | [optional] |
118
+ | **nextCursor** | **number**| Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. | [optional] |
119
+ | **brandIds** | [**Array<string>**](../docs/string.md)| BrandId(s) of the document. | [optional] |
120
+
121
+ ### Return type
122
+
123
+ [**BehalfDocumentRecords**](../docs/BehalfDocumentRecords.md)
124
+
125
+ ### Authorization
126
+
127
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
128
+
129
+ ### HTTP request headers
130
+
131
+ - **Content-Type**: Not defined
132
+ - **Accept**: `application/json`
133
+
134
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
135
+ [[Back to Model list]](../README.md#models)
136
+ [[Back to README]](../README.md)
137
+
138
+ ## `changeAccessCode()`
139
+
140
+ ```typescript
141
+ changeAccessCode(documentId: string, accessCodeDetails: AccessCodeDetails, emailId: string, zOrder: number)
142
+ ```
143
+
144
+ Changes the access code for the given document signer.
145
+
146
+
147
+ ### Parameters
148
+
149
+ |Name | Type | Description | Notes |
150
+ | ------------- | ------------- | ------------- | ------------- |
151
+ | **documentId** | **string**| | |
152
+ | **accessCodeDetails** | [**AccessCodeDetails**](../docs/AccessCodeDetails.md)| The new access code. | |
153
+ | **emailId** | **string**| | [optional] |
154
+ | **zOrder** | **number**| | [optional] |
155
+
156
+ ### Return type
157
+
158
+ void (empty response body)
159
+
160
+ ### Authorization
161
+
162
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
163
+
164
+ ### HTTP request headers
165
+
166
+ - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
167
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
168
+
169
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
170
+ [[Back to Model list]](../README.md#models)
171
+ [[Back to README]](../README.md)
172
+
173
+ ## `changeRecipient()`
174
+
175
+ ```typescript
176
+ changeRecipient(documentId: string, changeRecipient: ChangeRecipient)
177
+ ```
178
+
179
+ Change recipient details of a document.
180
+
181
+
182
+ ### Parameters
183
+
184
+ |Name | Type | Description | Notes |
185
+ | ------------- | ------------- | ------------- | ------------- |
186
+ | **documentId** | **string**| The documentID details. | |
187
+ | **changeRecipient** | [**ChangeRecipient**](../docs/ChangeRecipient.md)| The new recipient details. | |
188
+
189
+ ### Return type
190
+
191
+ void (empty response body)
192
+
193
+ ### Authorization
194
+
195
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
196
+
197
+ ### HTTP request headers
198
+
199
+ - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
200
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
201
+
202
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
203
+ [[Back to Model list]](../README.md#models)
204
+ [[Back to README]](../README.md)
205
+
206
+ ## `createEmbeddedRequestUrlDocument()`
207
+
208
+ ```typescript
209
+ createEmbeddedRequestUrlDocument(embeddedDocumentRequest: EmbeddedDocumentRequest): EmbeddedSendCreated
210
+ ```
211
+
212
+ Generates a send URL which embeds document sending process into your application.
213
+
214
+
215
+ ### Parameters
216
+
217
+ |Name | Type | Description | Notes |
218
+ | ------------- | ------------- | ------------- | ------------- |
219
+ | **embeddedDocumentRequest** | [**EmbeddedDocumentRequest**](../docs/EmbeddedDocumentRequest.md)| The embedded send document request body. | [optional] |
220
+
221
+ ### Return type
222
+
223
+ [**EmbeddedSendCreated**](../docs/EmbeddedSendCreated.md)
224
+
225
+ ### Authorization
226
+
227
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
228
+
229
+ ### HTTP request headers
230
+
231
+ - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
232
+ - **Accept**: `application/json`
233
+
234
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
235
+ [[Back to Model list]](../README.md#models)
236
+ [[Back to README]](../README.md)
237
+
238
+ ## `deleteDocument()`
239
+
240
+ ```typescript
241
+ deleteDocument(documentId: string, deletePermanently: boolean)
242
+ ```
243
+
244
+ Delete the document.
245
+
246
+
247
+ ### Parameters
248
+
249
+ |Name | Type | Description | Notes |
250
+ | ------------- | ------------- | ------------- | ------------- |
251
+ | **documentId** | **string**| Document Id. | |
252
+ | **deletePermanently** | **boolean**| Delete Permanently. | [optional] [default to false] |
253
+
254
+ ### Return type
255
+
256
+ void (empty response body)
257
+
258
+ ### Authorization
259
+
260
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
261
+
262
+ ### HTTP request headers
263
+
264
+ - **Content-Type**: Not defined
265
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
266
+
267
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
268
+ [[Back to Model list]](../README.md#models)
269
+ [[Back to README]](../README.md)
270
+
271
+ ## `deleteTag()`
272
+
273
+ ```typescript
274
+ deleteTag(documentTags: DocumentTags)
275
+ ```
276
+
277
+ Delete the Tags in Documents.
278
+
279
+
280
+ ### Parameters
281
+
282
+ |Name | Type | Description | Notes |
283
+ | ------------- | ------------- | ------------- | ------------- |
284
+ | **documentTags** | [**DocumentTags**](../docs/DocumentTags.md)| Contains DocumentId and LabelNames for Adding Tags. | [optional] |
285
+
286
+ ### Return type
287
+
288
+ void (empty response body)
289
+
290
+ ### Authorization
291
+
292
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
293
+
294
+ ### HTTP request headers
295
+
296
+ - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
297
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
298
+
299
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
300
+ [[Back to Model list]](../README.md#models)
301
+ [[Back to README]](../README.md)
302
+
303
+ ## `downloadAttachment()`
304
+
305
+ ```typescript
306
+ downloadAttachment(documentId: string, attachmentId: string, onBehalfOf: string): Buffer
307
+ ```
308
+
309
+ Download the Attachment.
310
+
311
+
312
+ ### Parameters
313
+
314
+ |Name | Type | Description | Notes |
315
+ | ------------- | ------------- | ------------- | ------------- |
316
+ | **documentId** | **string**| Document Id. | |
317
+ | **attachmentId** | **string**| Attachment Id(Get attachment ID from Properties API). | |
318
+ | **onBehalfOf** | **string**| The on behalfof email address. | [optional] |
319
+
320
+ ### Return type
321
+
322
+ **Buffer**
323
+
324
+ ### Authorization
325
+
326
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
327
+
328
+ ### HTTP request headers
329
+
330
+ - **Content-Type**: Not defined
331
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
332
+
333
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
334
+ [[Back to Model list]](../README.md#models)
335
+ [[Back to README]](../README.md)
336
+
337
+ ## `downloadAuditLog()`
338
+
339
+ ```typescript
340
+ downloadAuditLog(documentId: string, onBehalfOf: string): Buffer
341
+ ```
342
+
343
+ Download the audit trail document.
344
+
345
+
346
+ ### Parameters
347
+
348
+ |Name | Type | Description | Notes |
349
+ | ------------- | ------------- | ------------- | ------------- |
350
+ | **documentId** | **string**| Document Id. | |
351
+ | **onBehalfOf** | **string**| The on behalfof email address. | [optional] |
352
+
353
+ ### Return type
354
+
355
+ **Buffer**
356
+
357
+ ### Authorization
358
+
359
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
360
+
361
+ ### HTTP request headers
362
+
363
+ - **Content-Type**: Not defined
364
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
365
+
366
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
367
+ [[Back to Model list]](../README.md#models)
368
+ [[Back to README]](../README.md)
369
+
370
+ ## `downloadDocument()`
371
+
372
+ ```typescript
373
+ downloadDocument(documentId: string, onBehalfOf: string): Buffer
374
+ ```
375
+
376
+ Download the document.
377
+
378
+
379
+ ### Parameters
380
+
381
+ |Name | Type | Description | Notes |
382
+ | ------------- | ------------- | ------------- | ------------- |
383
+ | **documentId** | **string**| Document Id. | |
384
+ | **onBehalfOf** | **string**| The on behalfof email address. | [optional] |
385
+
386
+ ### Return type
387
+
388
+ **Buffer**
389
+
390
+ ### Authorization
391
+
392
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
393
+
394
+ ### HTTP request headers
395
+
396
+ - **Content-Type**: Not defined
397
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
398
+
399
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
400
+ [[Back to Model list]](../README.md#models)
401
+ [[Back to README]](../README.md)
402
+
403
+ ## `extendExpiry()`
404
+
405
+ ```typescript
406
+ extendExpiry(documentId: string, extendExpiry: ExtendExpiry)
407
+ ```
408
+
409
+ Extends the expiration date of the document.
410
+
411
+
412
+ ### Parameters
413
+
414
+ |Name | Type | Description | Notes |
415
+ | ------------- | ------------- | ------------- | ------------- |
416
+ | **documentId** | **string**| Document Id. | |
417
+ | **extendExpiry** | [**ExtendExpiry**](../docs/ExtendExpiry.md)| The new expiry value should be specified in yyyy-MM-dd format for days type, ISO date time format for specific date time and integer for hours type. | [optional] |
418
+
419
+ ### Return type
420
+
421
+ void (empty response body)
422
+
423
+ ### Authorization
424
+
425
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
426
+
427
+ ### HTTP request headers
428
+
429
+ - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
430
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
431
+
432
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
433
+ [[Back to Model list]](../README.md#models)
434
+ [[Back to README]](../README.md)
435
+
436
+ ## `getProperties()`
437
+
438
+ ```typescript
439
+ getProperties(documentId: string): DocumentProperties
440
+ ```
441
+
442
+ Get summary of the document.
443
+
444
+
445
+ ### Parameters
446
+
447
+ |Name | Type | Description | Notes |
448
+ | ------------- | ------------- | ------------- | ------------- |
449
+ | **documentId** | **string**| Document Id. | |
450
+
451
+ ### Return type
452
+
453
+ [**DocumentProperties**](../docs/DocumentProperties.md)
454
+
455
+ ### Authorization
456
+
457
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
458
+
459
+ ### HTTP request headers
460
+
461
+ - **Content-Type**: Not defined
462
+ - **Accept**: `application/json`
463
+
464
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
465
+ [[Back to Model list]](../README.md#models)
466
+ [[Back to README]](../README.md)
467
+
468
+ ## `getEmbeddedSignLink()`
469
+
470
+ ```typescript
471
+ getEmbeddedSignLink(documentId: string, signerEmail: string, countryCode: string, phoneNumber: string, signLinkValidTill: Date, redirectUrl: string): EmbeddedSigningLink
472
+ ```
473
+
474
+ Get sign link for Embedded Sign.
475
+
476
+
477
+ ### Parameters
478
+
479
+ |Name | Type | Description | Notes |
480
+ | ------------- | ------------- | ------------- | ------------- |
481
+ | **documentId** | **string**| | |
482
+ | **signerEmail** | **string**| | [optional] |
483
+ | **countryCode** | **string**| | [optional] |
484
+ | **phoneNumber** | **string**| | [optional] |
485
+ | **signLinkValidTill** | **Date**| | [optional] |
486
+ | **redirectUrl** | **string**| | [optional] |
487
+
488
+ ### Return type
489
+
490
+ [**EmbeddedSigningLink**](../docs/EmbeddedSigningLink.md)
491
+
492
+ ### Authorization
493
+
494
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
495
+
496
+ ### HTTP request headers
497
+
498
+ - **Content-Type**: Not defined
499
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
500
+
501
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
502
+ [[Back to Model list]](../README.md#models)
503
+ [[Back to README]](../README.md)
504
+
505
+ ## `listDocuments()`
506
+
507
+ ```typescript
508
+ listDocuments(page: number, sentBy: Array<string>, recipients: Array<string>, transmitType: 'Sent' | 'Received' | 'Both', dateFilterType: 'SentBetween' | 'Expiring', pageSize: number, startDate: Date, status: Array<'None' | 'WaitingForMe' | 'WaitingForOthers' | 'NeedAttention' | 'Completed' | 'Declined' | 'Revoked' | 'Expired' | 'Draft' | 'Scheduled'>, endDate: Date, searchKey: string, labels: Array<string>, nextCursor: number, brandIds: Array<string>): DocumentRecords
509
+ ```
510
+
511
+ List user documents.
512
+
513
+
514
+ ### Parameters
515
+
516
+ |Name | Type | Description | Notes |
517
+ | ------------- | ------------- | ------------- | ------------- |
518
+ | **page** | **number**| Page index specified in get document list request. | [default to 1] |
519
+ | **sentBy** | [**Array<string>**](../docs/string.md)| | [optional] |
520
+ | **recipients** | [**Array<string>**](../docs/string.md)| | [optional] |
521
+ | **transmitType** | **'Sent' | 'Received' | 'Both'**| | [optional] |
522
+ | **dateFilterType** | **'SentBetween' | 'Expiring'**| Date Filter as SentBetween and ExpiresOn. | [optional] |
523
+ | **pageSize** | **number**| Page size specified in get document list request. | [optional] [default to 10] |
524
+ | **startDate** | **Date**| Start date of the document | [optional] |
525
+ | **status** | [**Array<'None' | 'WaitingForMe' | 'WaitingForOthers' | 'NeedAttention' | 'Completed' | 'Declined' | 'Revoked' | 'Expired' | 'Draft' | 'Scheduled'>**](../docs/string.md)| Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. | [optional] |
526
+ | **endDate** | **Date**| End date of the document | [optional] |
527
+ | **searchKey** | **string**| Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., | [optional] |
528
+ | **labels** | [**Array<string>**](../docs/string.md)| Labels of the document. | [optional] |
529
+ | **nextCursor** | **number**| Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. | [optional] |
530
+ | **brandIds** | [**Array<string>**](../docs/string.md)| BrandId(s) of the document. | [optional] |
531
+
532
+ ### Return type
533
+
534
+ [**DocumentRecords**](../docs/DocumentRecords.md)
535
+
536
+ ### Authorization
537
+
538
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
539
+
540
+ ### HTTP request headers
541
+
542
+ - **Content-Type**: Not defined
543
+ - **Accept**: `application/json`
544
+
545
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
546
+ [[Back to Model list]](../README.md#models)
547
+ [[Back to README]](../README.md)
548
+
549
+ ## `prefillFields()`
550
+
551
+ ```typescript
552
+ prefillFields(documentId: string, prefillFieldRequest: PrefillFieldRequest)
553
+ ```
554
+
555
+ Updates the value (prefill) of the fields in the document.
556
+
557
+
558
+ ### Parameters
559
+
560
+ |Name | Type | Description | Notes |
561
+ | ------------- | ------------- | ------------- | ------------- |
562
+ | **documentId** | **string**| The DocumentId. | |
563
+ | **prefillFieldRequest** | [**PrefillFieldRequest**](../docs/PrefillFieldRequest.md)| The prefill field request. | |
564
+
565
+ ### Return type
566
+
567
+ void (empty response body)
568
+
569
+ ### Authorization
570
+
571
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
572
+
573
+ ### HTTP request headers
574
+
575
+ - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
576
+ - **Accept**: `application/json`
577
+
578
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
579
+ [[Back to Model list]](../README.md#models)
580
+ [[Back to README]](../README.md)
581
+
582
+ ## `remindDocument()`
583
+
584
+ ```typescript
585
+ remindDocument(documentId: string, receiverEmails: Array<string>, reminderMessage: ReminderMessage)
586
+ ```
587
+
588
+ Send reminder to pending signers.
589
+
590
+
591
+ ### Parameters
592
+
593
+ |Name | Type | Description | Notes |
594
+ | ------------- | ------------- | ------------- | ------------- |
595
+ | **documentId** | **string**| Document Id. | |
596
+ | **receiverEmails** | [**Array<string>**](../docs/string.md)| Signer emails. | [optional] |
597
+ | **reminderMessage** | [**ReminderMessage**](../docs/ReminderMessage.md)| Reminder Message for signers. | [optional] |
598
+
599
+ ### Return type
600
+
601
+ void (empty response body)
602
+
603
+ ### Authorization
604
+
605
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
606
+
607
+ ### HTTP request headers
608
+
609
+ - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
610
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
611
+
612
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
613
+ [[Back to Model list]](../README.md#models)
614
+ [[Back to README]](../README.md)
615
+
616
+ ## `removeAuthentication()`
617
+
618
+ ```typescript
619
+ removeAuthentication(documentId: string, removeAuthentication: RemoveAuthentication)
620
+ ```
621
+
622
+ Remove the access code for the given document signer.
623
+
624
+
625
+ ### Parameters
626
+
627
+ |Name | Type | Description | Notes |
628
+ | ------------- | ------------- | ------------- | ------------- |
629
+ | **documentId** | **string**| Document ID of the signature request | |
630
+ | **removeAuthentication** | [**RemoveAuthentication**](../docs/RemoveAuthentication.md)| To remove access code. | [optional] |
631
+
632
+ ### Return type
633
+
634
+ void (empty response body)
635
+
636
+ ### Authorization
637
+
638
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
639
+
640
+ ### HTTP request headers
641
+
642
+ - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
643
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
644
+
645
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
646
+ [[Back to Model list]](../README.md#models)
647
+ [[Back to README]](../README.md)
648
+
649
+ ## `revokeDocument()`
650
+
651
+ ```typescript
652
+ revokeDocument(documentId: string, revokeDocument: RevokeDocument)
653
+ ```
654
+
655
+ Revoke the document.
656
+
657
+
658
+ ### Parameters
659
+
660
+ |Name | Type | Description | Notes |
661
+ | ------------- | ------------- | ------------- | ------------- |
662
+ | **documentId** | **string**| Document Id. | |
663
+ | **revokeDocument** | [**RevokeDocument**](../docs/RevokeDocument.md)| RevokeDetails. | |
664
+
665
+ ### Return type
666
+
667
+ void (empty response body)
668
+
669
+ ### Authorization
670
+
671
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
672
+
673
+ ### HTTP request headers
674
+
675
+ - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
676
+ - **Accept**: `application/json`
677
+
678
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
679
+ [[Back to Model list]](../README.md#models)
680
+ [[Back to README]](../README.md)
681
+
682
+ ## `sendDocument()`
683
+
684
+ ```typescript
685
+ sendDocument(sendForSign: SendForSign): DocumentCreated
686
+ ```
687
+
688
+ Sends the document for sign.
689
+
690
+
691
+ ### Parameters
692
+
693
+ |Name | Type | Description | Notes |
694
+ | ------------- | ------------- | ------------- | ------------- |
695
+ | **sendForSign** | [**SendForSign**](../docs/SendForSign.md)| The send for sign request body. | [optional] |
696
+
697
+ ### Return type
698
+
699
+ [**DocumentCreated**](../docs/DocumentCreated.md)
700
+
701
+ ### Authorization
702
+
703
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
704
+
705
+ ### HTTP request headers
706
+
707
+ - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
708
+ - **Accept**: `application/json`
709
+
710
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
711
+ [[Back to Model list]](../README.md#models)
712
+ [[Back to README]](../README.md)
713
+
714
+ ## `teamDocuments()`
715
+
716
+ ```typescript
717
+ teamDocuments(page: number, userId: Array<string>, teamId: Array<string>, transmitType: 'Sent' | 'Received' | 'Both', dateFilterType: 'SentBetween' | 'Expiring', pageSize: number, startDate: Date, status: Array<'None' | 'WaitingForMe' | 'WaitingForOthers' | 'NeedAttention' | 'Completed' | 'Declined' | 'Revoked' | 'Expired' | 'Draft' | 'Scheduled'>, endDate: Date, searchKey: string, labels: Array<string>, nextCursor: number, brandIds: Array<string>): TeamDocumentRecords
718
+ ```
719
+
720
+ Get user Team documents.
721
+
722
+
723
+ ### Parameters
724
+
725
+ |Name | Type | Description | Notes |
726
+ | ------------- | ------------- | ------------- | ------------- |
727
+ | **page** | **number**| Page index specified in get document list request. | [default to 1] |
728
+ | **userId** | [**Array<string>**](../docs/string.md)| UserId of the Team document. | [optional] |
729
+ | **teamId** | [**Array<string>**](../docs/string.md)| TeamId of the Team document. | [optional] |
730
+ | **transmitType** | **'Sent' | 'Received' | 'Both'**| Transmit type as Sent, Received and Both. | [optional] |
731
+ | **dateFilterType** | **'SentBetween' | 'Expiring'**| Date Filter as SentBetween and Expiring. | [optional] |
732
+ | **pageSize** | **number**| Page size specified in get document list request. | [optional] [default to 10] |
733
+ | **startDate** | **Date**| Start date of the document | [optional] |
734
+ | **status** | [**Array<'None' | 'WaitingForMe' | 'WaitingForOthers' | 'NeedAttention' | 'Completed' | 'Declined' | 'Revoked' | 'Expired' | 'Draft' | 'Scheduled'>**](../docs/string.md)| Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. | [optional] |
735
+ | **endDate** | **Date**| End date of the document | [optional] |
736
+ | **searchKey** | **string**| Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., | [optional] |
737
+ | **labels** | [**Array<string>**](../docs/string.md)| Labels of the document. | [optional] |
738
+ | **nextCursor** | **number**| Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. | [optional] |
739
+ | **brandIds** | [**Array<string>**](../docs/string.md)| BrandId(s) of the document. | [optional] |
740
+
741
+ ### Return type
742
+
743
+ [**TeamDocumentRecords**](../docs/TeamDocumentRecords.md)
744
+
745
+ ### Authorization
746
+
747
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
748
+
749
+ ### HTTP request headers
750
+
751
+ - **Content-Type**: Not defined
752
+ - **Accept**: `application/json`
753
+
754
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
755
+ [[Back to Model list]](../README.md#models)
756
+ [[Back to README]](../README.md)