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,13 @@
1
+ # # TemplateSenderDetails
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ | `name` | ```string``` | | |
10
+ | `emailAddress` | ```string``` | | |
11
+ | `userId` | ```string``` | | |
12
+
13
+ [[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,12 @@
1
+ # # TemplateSharedTemplateDetail
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ | `teamId` | ```string``` | | |
10
+ | `accessType` | ```string``` | | |
11
+
12
+ [[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,27 @@
1
+ # # TemplateSignerDetails
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ | `signerName` | ```string``` | | |
10
+ | `signerRole` | ```string``` | | |
11
+ | `signerEmail` | ```string``` | | |
12
+ | `phoneNumber` | [```PhoneNumber```](PhoneNumber.md) | | |
13
+ | `status` | ```string``` | | |
14
+ | `enableAccessCode` | ```boolean``` | | |
15
+ | `enableEmailOTP` | ```boolean``` | | |
16
+ | `imposeAuthentication` | ```string``` | | |
17
+ | `deliveryMode` | ```string``` | | |
18
+ | `allowFieldConfiguration` | ```boolean``` | | [default to false] |
19
+ | `userId` | ```string``` | | |
20
+ | `order` | ```number``` | | |
21
+ | `signerType` | ```string``` | | [default to SignerTypeEnum.Signer] |
22
+ | `hostEmail` | ```string``` | | |
23
+ | `hostName` | ```string``` | | |
24
+ | `hostUserId` | ```string``` | | |
25
+ | `signType` | ```string``` | | |
26
+
27
+ [[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,14 @@
1
+ # # TemplateTag
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ | `templateId`<sup>*_required_</sup> | ```string``` | | |
10
+ | `documentLabels` | ```Array<string>``` | | |
11
+ | `templateLabels` | ```Array<string>``` | | |
12
+ | `onBehalfOf` | ```string``` | | |
13
+
14
+ [[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,40 @@
1
+ # # TextTagDefinition
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ | `definitionId`<sup>*_required_</sup> | ```string``` | | |
10
+ | `type`<sup>*_required_</sup> | ```string``` | | |
11
+ | `signerIndex`<sup>*_required_</sup> | ```number``` | | |
12
+ | `isRequired` | ```boolean``` | | |
13
+ | `placeholder` | ```string``` | | |
14
+ | `fieldId` | ```string``` | | |
15
+ | `font` | [```Font```](Font.md) | | |
16
+ | `validation` | [```Validation```](Validation.md) | | |
17
+ | `size` | [```Size```](Size.md) | | |
18
+ | `dateFormat` | ```string``` | | |
19
+ | `timeFormat` | ```string``` | | |
20
+ | `radioGroupName` | ```string``` | | |
21
+ | `groupName` | ```string``` | | |
22
+ | `value` | ```string``` | | |
23
+ | `dropdownOptions` | ```Array<string>``` | | |
24
+ | `imageInfo` | [```ImageInfo```](ImageInfo.md) | | |
25
+ | `hyperlinkText` | ```string``` | | |
26
+ | `attachmentInfo` | [```AttachmentInfo```](AttachmentInfo.md) | | |
27
+ | `backgroundHexColor` | ```string``` | | |
28
+ | `isReadOnly` | ```boolean``` | | |
29
+ | `offset` | [```TextTagOffset```](TextTagOffset.md) | | |
30
+ | `label` | ```string``` | | |
31
+ | `tabIndex` | ```number``` | | |
32
+ | `dataSyncTag` | ```string``` | | |
33
+ | `textAlign` | ```string``` | | |
34
+ | `textDirection` | ```string``` | | |
35
+ | `characterSpacing` | ```number``` | | |
36
+ | `characterLimit` | ```number``` | | |
37
+ | `formulaFieldSettings` | [```FormulaFieldSettings```](FormulaFieldSettings.md) | | |
38
+ | `resizeOption` | ```string``` | | |
39
+
40
+ [[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,12 @@
1
+ # # TextTagOffset
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ | `offsetX` | ```number``` | | |
10
+ | `offsetY` | ```number``` | | |
11
+
12
+ [[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,14 @@
1
+ # # UpdateUser
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ | `userId`<sup>*_required_</sup> | ```string``` | | |
10
+ | `userRole` | ```string``` | | |
11
+ | `userStatus` | ```string``` | | |
12
+ | `toUserId` | ```string``` | | |
13
+
14
+ [[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,12 @@
1
+ # # UpdateUserMetaData
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ | `userId`<sup>*_required_</sup> | ```string``` | | |
10
+ | `metaData`<sup>*_required_</sup> | ```{ [key: string]: string | null; }``` | | |
11
+
12
+ [[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,240 @@
1
+ # UserApi
2
+
3
+ All URIs are relative to https://api.boldsign.com.
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------------- | ------------- | ------------- |
7
+ | [**cancelInvitation()**](UserApi.md#cancelInvitation) | **POST** /v1/users/cancelInvitation | Cancel the users invitation. |
8
+ | [**createUser()**](UserApi.md#createUser) | **POST** /v1/users/create | Create the user. |
9
+ | [**getUser()**](UserApi.md#getUser) | **GET** /v1/users/get | Get summary of the user. |
10
+ | [**listUsers()**](UserApi.md#listUsers) | **GET** /v1/users/list | List user documents. |
11
+ | [**resendInvitation()**](UserApi.md#resendInvitation) | **POST** /v1/users/resendInvitation | Resend the users invitation. |
12
+ | [**updateMetaData()**](UserApi.md#updateMetaData) | **PUT** /v1/users/updateMetaData | Update new User meta data details. |
13
+ | [**updateUser()**](UserApi.md#updateUser) | **PUT** /v1/users/update | Update new User role. |
14
+
15
+
16
+ ## `cancelInvitation()`
17
+
18
+ ```typescript
19
+ cancelInvitation(userId: string)
20
+ ```
21
+
22
+ Cancel the users invitation.
23
+
24
+
25
+ ### Parameters
26
+
27
+ |Name | Type | Description | Notes |
28
+ | ------------- | ------------- | ------------- | ------------- |
29
+ | **userId** | **string**| | |
30
+
31
+ ### Return type
32
+
33
+ void (empty response body)
34
+
35
+ ### Authorization
36
+
37
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
38
+
39
+ ### HTTP request headers
40
+
41
+ - **Content-Type**: Not defined
42
+ - **Accept**: `application/json`
43
+
44
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
45
+ [[Back to Model list]](../README.md#models)
46
+ [[Back to README]](../README.md)
47
+
48
+ ## `createUser()`
49
+
50
+ ```typescript
51
+ createUser(createUser: Array<CreateUser>)
52
+ ```
53
+
54
+ Create the user.
55
+
56
+
57
+ ### Parameters
58
+
59
+ |Name | Type | Description | Notes |
60
+ | ------------- | ------------- | ------------- | ------------- |
61
+ | **createUser** | [**Array<CreateUser>**](../docs/CreateUser.md)| The create user. | [optional] |
62
+
63
+ ### Return type
64
+
65
+ void (empty response body)
66
+
67
+ ### Authorization
68
+
69
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
70
+
71
+ ### HTTP request headers
72
+
73
+ - **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`
74
+ - **Accept**: `application/json`
75
+
76
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
77
+ [[Back to Model list]](../README.md#models)
78
+ [[Back to README]](../README.md)
79
+
80
+ ## `getUser()`
81
+
82
+ ```typescript
83
+ getUser(userId: string): UserProperties
84
+ ```
85
+
86
+ Get summary of the user.
87
+
88
+
89
+ ### Parameters
90
+
91
+ |Name | Type | Description | Notes |
92
+ | ------------- | ------------- | ------------- | ------------- |
93
+ | **userId** | **string**| User Id. | |
94
+
95
+ ### Return type
96
+
97
+ [**UserProperties**](../docs/UserProperties.md)
98
+
99
+ ### Authorization
100
+
101
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
102
+
103
+ ### HTTP request headers
104
+
105
+ - **Content-Type**: Not defined
106
+ - **Accept**: `application/json`
107
+
108
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
109
+ [[Back to Model list]](../README.md#models)
110
+ [[Back to README]](../README.md)
111
+
112
+ ## `listUsers()`
113
+
114
+ ```typescript
115
+ listUsers(page: number, pageSize: number, search: string): UserRecords
116
+ ```
117
+
118
+ List user documents.
119
+
120
+
121
+ ### Parameters
122
+
123
+ |Name | Type | Description | Notes |
124
+ | ------------- | ------------- | ------------- | ------------- |
125
+ | **page** | **number**| Page index specified in get user list request. | [default to 1] |
126
+ | **pageSize** | **number**| Page size specified in get user list request. | [optional] [default to 10] |
127
+ | **search** | **string**| Users can be listed by the search based on the user ID | [optional] |
128
+
129
+ ### Return type
130
+
131
+ [**UserRecords**](../docs/UserRecords.md)
132
+
133
+ ### Authorization
134
+
135
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
136
+
137
+ ### HTTP request headers
138
+
139
+ - **Content-Type**: Not defined
140
+ - **Accept**: `application/json`
141
+
142
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
143
+ [[Back to Model list]](../README.md#models)
144
+ [[Back to README]](../README.md)
145
+
146
+ ## `resendInvitation()`
147
+
148
+ ```typescript
149
+ resendInvitation(userId: string)
150
+ ```
151
+
152
+ Resend the users invitation.
153
+
154
+
155
+ ### Parameters
156
+
157
+ |Name | Type | Description | Notes |
158
+ | ------------- | ------------- | ------------- | ------------- |
159
+ | **userId** | **string**| | |
160
+
161
+ ### Return type
162
+
163
+ void (empty response body)
164
+
165
+ ### Authorization
166
+
167
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
168
+
169
+ ### HTTP request headers
170
+
171
+ - **Content-Type**: Not defined
172
+ - **Accept**: `application/json`
173
+
174
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
175
+ [[Back to Model list]](../README.md#models)
176
+ [[Back to README]](../README.md)
177
+
178
+ ## `updateMetaData()`
179
+
180
+ ```typescript
181
+ updateMetaData(updateUserMetaData: UpdateUserMetaData)
182
+ ```
183
+
184
+ Update new User meta data details.
185
+
186
+
187
+ ### Parameters
188
+
189
+ |Name | Type | Description | Notes |
190
+ | ------------- | ------------- | ------------- | ------------- |
191
+ | **updateUserMetaData** | [**UpdateUserMetaData**](../docs/UpdateUserMetaData.md)| update query. | [optional] |
192
+
193
+ ### Return type
194
+
195
+ void (empty response body)
196
+
197
+ ### Authorization
198
+
199
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
200
+
201
+ ### HTTP request headers
202
+
203
+ - **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`
204
+ - **Accept**: `application/json`
205
+
206
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
207
+ [[Back to Model list]](../README.md#models)
208
+ [[Back to README]](../README.md)
209
+
210
+ ## `updateUser()`
211
+
212
+ ```typescript
213
+ updateUser(updateUser: UpdateUser)
214
+ ```
215
+
216
+ Update new User role.
217
+
218
+
219
+ ### Parameters
220
+
221
+ |Name | Type | Description | Notes |
222
+ | ------------- | ------------- | ------------- | ------------- |
223
+ | **updateUser** | [**UpdateUser**](../docs/UpdateUser.md)| update query. | [optional] |
224
+
225
+ ### Return type
226
+
227
+ void (empty response body)
228
+
229
+ ### Authorization
230
+
231
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
232
+
233
+ ### HTTP request headers
234
+
235
+ - **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`
236
+ - **Accept**: `application/json`
237
+
238
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
239
+ [[Back to Model list]](../README.md#models)
240
+ [[Back to README]](../README.md)
@@ -0,0 +1,12 @@
1
+ # # UserPageDetails
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ | `pageSize` | ```number``` | | |
10
+ | `page` | ```number``` | | |
11
+
12
+ [[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,21 @@
1
+ # # UserProperties
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ | `userId` | ```string``` | | |
10
+ | `email` | ```string``` | | |
11
+ | `firstName` | ```string``` | | |
12
+ | `lastName` | ```string``` | | |
13
+ | `teamId` | ```string``` | | |
14
+ | `teamName` | ```string``` | | |
15
+ | `role` | ```string``` | | |
16
+ | `userStatus` | ```string``` | | |
17
+ | `createdDate` | ```number``` | | |
18
+ | `modifiedDate` | ```number``` | | |
19
+ | `metaData` | ```{ [key: string]: string | null; }``` | | |
20
+
21
+ [[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,12 @@
1
+ # # UserRecords
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ | `pageDetails` | [```UserPageDetails```](UserPageDetails.md) | | |
10
+ | `result` | [```Array<UsersDetails>```](UsersDetails.md) | | |
11
+
12
+ [[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,21 @@
1
+ # # UsersDetails
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ | `userId` | ```string``` | | |
10
+ | `email` | ```string``` | | |
11
+ | `firstName` | ```string``` | | |
12
+ | `lastName` | ```string``` | | |
13
+ | `teamId` | ```string``` | | |
14
+ | `teamName` | ```string``` | | |
15
+ | `role` | ```string``` | | |
16
+ | `userStatus` | ```string``` | | |
17
+ | `createdDate` | ```number``` | | |
18
+ | `modifiedDate` | ```number``` | | |
19
+ | `metaData` | ```{ [key: string]: string | null; }``` | | |
20
+
21
+ [[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,13 @@
1
+ # # Validation
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ | `type`<sup>*_required_</sup> | ```string``` | | |
10
+ | `regex` | ```string``` | | |
11
+ | `regexMessage` | ```string``` | | |
12
+
13
+ [[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,15 @@
1
+ # # VerificationDataRequest
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ | `emailId` | ```string``` | | |
10
+ | `countryCode` | ```string``` | | |
11
+ | `phoneNumber` | ```string``` | | |
12
+ | `order` | ```number``` | | |
13
+ | `onBehalfOf` | ```string``` | | |
14
+
15
+ [[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,34 @@
1
+ # # ViewBrandDetails
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ | `brandId` | ```string``` | | |
10
+ | `brandLogo` | ```string``` | | |
11
+ | `brandName` | ```string``` | | |
12
+ | `backgroundColor` | ```string``` | | |
13
+ | `buttonColor` | ```string``` | | |
14
+ | `buttonTextColor` | ```string``` | | |
15
+ | `emailDisplayName` | ```string``` | | |
16
+ | `disclaimerTitle` | ```string``` | | |
17
+ | `disclaimerDescription` | ```string``` | | |
18
+ | `redirectUrl` | ```string``` | | |
19
+ | `isDefault` | ```boolean``` | | |
20
+ | `canHideTagLine` | ```boolean``` | | |
21
+ | `combineAuditTrail` | ```boolean``` | | |
22
+ | `excludeAuditTrailFromEmail` | ```boolean``` | | |
23
+ | `emailSignedDocument` | ```string``` | | |
24
+ | `documentTimeZone` | ```string``` | | |
25
+ | `showBuiltInFormFields` | ```boolean``` | | |
26
+ | `allowCustomFieldCreation` | ```boolean``` | | |
27
+ | `showSharedCustomFields` | ```boolean``` | | |
28
+ | `hideDecline` | ```boolean``` | | |
29
+ | `hideSave` | ```boolean``` | | |
30
+ | `documentExpirySettings` | [```DocumentExpirySettings```](DocumentExpirySettings.md) | | |
31
+ | `customDomainSettings` | [```CustomDomainSettings```](CustomDomainSettings.md) | | |
32
+ | `isDomainVerified` | ```boolean``` | | |
33
+
34
+ [[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,17 @@
1
+ # # ViewCustomFieldDetails
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ | `customFieldId` | ```string``` | | |
10
+ | `fieldName` | ```string``` | | |
11
+ | `fieldDescription` | ```string``` | | |
12
+ | `fieldOrder` | ```number``` | | |
13
+ | `brandId` | ```string``` | | |
14
+ | `sharedField` | ```boolean``` | | |
15
+ | `formField` | [```CustomFormField```](CustomFormField.md) | | |
16
+
17
+ [[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
@@ -11,6 +11,7 @@
11
11
  */
12
12
 
13
13
  import { RequestFile } from './models';
14
+ import { AuthenticationSettings } from './authenticationSettings';
14
15
  import { IdentityVerificationSettings } from './identityVerificationSettings';
15
16
  import { PhoneNumber } from './phoneNumber';
16
17
 
@@ -23,6 +24,7 @@ export class AccessCodeDetail {
23
24
  'phoneNumber'?: PhoneNumber;
24
25
  'identityVerificationSettings'?: IdentityVerificationSettings;
25
26
  'authenticationRetryCount'?: number | null;
27
+ 'authenticationSettings'?: AuthenticationSettings;
26
28
 
27
29
  static discriminator: string | undefined = undefined;
28
30
 
@@ -66,6 +68,11 @@ export class AccessCodeDetail {
66
68
  "name": "authenticationRetryCount",
67
69
  "baseName": "authenticationRetryCount",
68
70
  "type": "number"
71
+ },
72
+ {
73
+ "name": "authenticationSettings",
74
+ "baseName": "authenticationSettings",
75
+ "type": "AuthenticationSettings"
69
76
  } ];
70
77
 
71
78
  static getAttributeTypeMap() {
@@ -0,0 +1,39 @@
1
+ /**
2
+ * BoldSign API
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: 1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+
13
+ import { RequestFile } from './models';
14
+
15
+ export class AuthenticationSettings {
16
+ 'authenticationFrequency'?: AuthenticationSettings.AuthenticationFrequencyEnum;
17
+
18
+ static discriminator: string | undefined = undefined;
19
+
20
+ static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
21
+ {
22
+ "name": "authenticationFrequency",
23
+ "baseName": "authenticationFrequency",
24
+ "type": "AuthenticationSettings.AuthenticationFrequencyEnum"
25
+ } ];
26
+
27
+ static getAttributeTypeMap() {
28
+ return AuthenticationSettings.attributeTypeMap;
29
+ }
30
+ }
31
+
32
+ export namespace AuthenticationSettings {
33
+ export enum AuthenticationFrequencyEnum {
34
+ None = <any> 'None',
35
+ EveryAccess = <any> 'EveryAccess',
36
+ UntilSignCompleted = <any> 'UntilSignCompleted',
37
+ OncePerDocument = <any> 'OncePerDocument'
38
+ }
39
+ }
@@ -11,6 +11,7 @@
11
11
  */
12
12
 
13
13
  import { RequestFile } from './models';
14
+ import { AuthenticationSettings } from './authenticationSettings';
14
15
  import { FormField } from './formField';
15
16
  import { IdentityVerificationSettings } from './identityVerificationSettings';
16
17
  import { PhoneNumber } from './phoneNumber';
@@ -40,6 +41,7 @@ export class DocumentSigner {
40
41
  'recipientNotificationSettings'?: RecipientNotificationSettings;
41
42
  'authenticationRetryCount'?: number | null;
42
43
  'enableQes'?: boolean | null;
44
+ 'authenticationSettings'?: AuthenticationSettings;
43
45
 
44
46
  static discriminator: string | undefined = undefined;
45
47
 
@@ -143,6 +145,11 @@ export class DocumentSigner {
143
145
  "name": "enableQes",
144
146
  "baseName": "enableQes",
145
147
  "type": "boolean"
148
+ },
149
+ {
150
+ "name": "authenticationSettings",
151
+ "baseName": "authenticationSettings",
152
+ "type": "AuthenticationSettings"
146
153
  } ];
147
154
 
148
155
  static getAttributeTypeMap() {