docspring-ts 4.3.0 → 4.4.0

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 (154) hide show
  1. package/README.md +20 -1
  2. package/dist/RequestSchemas.js +1691 -145
  3. package/dist/RequestSchemas.js.map +1 -1
  4. package/dist/RequestValidator.js +3 -0
  5. package/dist/RequestValidator.js.map +1 -1
  6. package/dist/apis/Client.d.ts +82 -32
  7. package/dist/apis/Client.js +3658 -1666
  8. package/dist/apis/Client.js.map +1 -1
  9. package/dist/http/isomorphic-fetch.js +1 -1
  10. package/dist/models/CreateAccountEmailActionRequest.d.ts +42 -0
  11. package/dist/models/CreateAccountEmailActionRequest.js +131 -0
  12. package/dist/models/CreateAccountEmailActionRequest.js.map +1 -0
  13. package/dist/models/CreateEmailActionRequest.d.ts +40 -0
  14. package/dist/models/CreateEmailActionRequest.js +119 -0
  15. package/dist/models/CreateEmailActionRequest.js.map +1 -0
  16. package/dist/models/CreateEmailDomainRequest.d.ts +20 -0
  17. package/dist/models/CreateEmailDomainRequest.js +23 -0
  18. package/dist/models/CreateEmailDomainRequest.js.map +1 -0
  19. package/dist/models/CreateSubmissionRequest.d.ts +11 -0
  20. package/dist/models/CreateSubmissionRequest.js +54 -0
  21. package/dist/models/CreateSubmissionRequest.js.map +1 -1
  22. package/dist/models/CreateTemplateRequest.d.ts +11 -0
  23. package/dist/models/CreateTemplateRequest.js +48 -0
  24. package/dist/models/CreateTemplateRequest.js.map +1 -1
  25. package/dist/models/DnsRecordType.d.ts +6 -0
  26. package/dist/models/DnsRecordType.js +9 -0
  27. package/dist/models/DnsRecordType.js.map +1 -0
  28. package/dist/models/EmailAction.d.ts +54 -0
  29. package/dist/models/EmailAction.js +197 -0
  30. package/dist/models/EmailAction.js.map +1 -0
  31. package/dist/models/EmailActionConditions.d.ts +23 -0
  32. package/dist/models/EmailActionConditions.js +29 -0
  33. package/dist/models/EmailActionConditions.js.map +1 -0
  34. package/dist/models/EmailActionConditionsInput.d.ts +23 -0
  35. package/dist/models/EmailActionConditionsInput.js +29 -0
  36. package/dist/models/EmailActionConditionsInput.js.map +1 -0
  37. package/dist/models/EmailActionCustomization.d.ts +30 -0
  38. package/dist/models/EmailActionCustomization.js +77 -0
  39. package/dist/models/EmailActionCustomization.js.map +1 -0
  40. package/dist/models/EmailActionDelivery.d.ts +5 -0
  41. package/dist/models/EmailActionDelivery.js +8 -0
  42. package/dist/models/EmailActionDelivery.js.map +1 -0
  43. package/dist/models/EmailActionFileFormats.d.ts +7 -0
  44. package/dist/models/EmailActionFileFormats.js +10 -0
  45. package/dist/models/EmailActionFileFormats.js.map +1 -0
  46. package/dist/models/EmailActionList.d.ts +22 -0
  47. package/dist/models/EmailActionList.js +29 -0
  48. package/dist/models/EmailActionList.js.map +1 -0
  49. package/dist/models/EmailActionSetting.d.ts +17 -0
  50. package/dist/models/EmailActionSetting.js +20 -0
  51. package/dist/models/EmailActionSetting.js.map +1 -0
  52. package/dist/models/EmailActionSubmissionType.d.ts +6 -0
  53. package/dist/models/EmailActionSubmissionType.js +9 -0
  54. package/dist/models/EmailActionSubmissionType.js.map +1 -0
  55. package/dist/models/EmailActionTestEmail.d.ts +20 -0
  56. package/dist/models/EmailActionTestEmail.js +23 -0
  57. package/dist/models/EmailActionTestEmail.js.map +1 -0
  58. package/dist/models/EmailDomain.d.ts +33 -0
  59. package/dist/models/EmailDomain.js +83 -0
  60. package/dist/models/EmailDomain.js.map +1 -0
  61. package/dist/models/EmailDomainDnsRecord.d.ts +25 -0
  62. package/dist/models/EmailDomainDnsRecord.js +41 -0
  63. package/dist/models/EmailDomainDnsRecord.js.map +1 -0
  64. package/dist/models/EmailDomainDnsRecordPurpose.d.ts +6 -0
  65. package/dist/models/EmailDomainDnsRecordPurpose.js +9 -0
  66. package/dist/models/EmailDomainDnsRecordPurpose.js.map +1 -0
  67. package/dist/models/EmailDomainList.d.ts +22 -0
  68. package/dist/models/EmailDomainList.js +29 -0
  69. package/dist/models/EmailDomainList.js.map +1 -0
  70. package/dist/models/EmailDomainRecordState.d.ts +6 -0
  71. package/dist/models/EmailDomainRecordState.js +9 -0
  72. package/dist/models/EmailDomainRecordState.js.map +1 -0
  73. package/dist/models/EmailDomainState.d.ts +6 -0
  74. package/dist/models/EmailDomainState.js +9 -0
  75. package/dist/models/EmailDomainState.js.map +1 -0
  76. package/dist/models/ErrorCode.d.ts +2 -0
  77. package/dist/models/ErrorCode.js +2 -0
  78. package/dist/models/ErrorCode.js.map +1 -1
  79. package/dist/models/ErrorInfo.d.ts +3 -0
  80. package/dist/models/ErrorInfo.js +18 -0
  81. package/dist/models/ErrorInfo.js.map +1 -1
  82. package/dist/models/ObjectSerializer.d.ts +28 -0
  83. package/dist/models/ObjectSerializer.js +73 -0
  84. package/dist/models/ObjectSerializer.js.map +1 -1
  85. package/dist/models/SendAccountEmailActionTestEmailRequest.d.ts +20 -0
  86. package/dist/models/SendAccountEmailActionTestEmailRequest.js +23 -0
  87. package/dist/models/SendAccountEmailActionTestEmailRequest.js.map +1 -0
  88. package/dist/models/SignatureRequest.d.ts +5 -0
  89. package/dist/models/SignatureRequest.js +24 -0
  90. package/dist/models/SignatureRequest.js.map +1 -1
  91. package/dist/models/SignatureRequestEmailAttachments.d.ts +5 -0
  92. package/dist/models/SignatureRequestEmailAttachments.js +8 -0
  93. package/dist/models/SignatureRequestEmailAttachments.js.map +1 -0
  94. package/dist/models/SignatureRequestEmailStatus.d.ts +11 -0
  95. package/dist/models/SignatureRequestEmailStatus.js +14 -0
  96. package/dist/models/SignatureRequestEmailStatus.js.map +1 -0
  97. package/dist/models/SignatureRequestEventType.d.ts +2 -0
  98. package/dist/models/SignatureRequestEventType.js +3 -1
  99. package/dist/models/SignatureRequestEventType.js.map +1 -1
  100. package/dist/models/SignatureRequestInput.d.ts +3 -1
  101. package/dist/models/SignatureRequestInput.js +12 -0
  102. package/dist/models/SignatureRequestInput.js.map +1 -1
  103. package/dist/models/SignatureRequestReminders.d.ts +21 -0
  104. package/dist/models/SignatureRequestReminders.js +29 -0
  105. package/dist/models/SignatureRequestReminders.js.map +1 -0
  106. package/dist/models/SigningOrder.d.ts +5 -0
  107. package/dist/models/SigningOrder.js +8 -0
  108. package/dist/models/SigningOrder.js.map +1 -0
  109. package/dist/models/StringConditionType.d.ts +7 -0
  110. package/dist/models/StringConditionType.js +8 -1
  111. package/dist/models/StringConditionType.js.map +1 -1
  112. package/dist/models/Submission.d.ts +2 -0
  113. package/dist/models/Submission.js +6 -0
  114. package/dist/models/Submission.js.map +1 -1
  115. package/dist/models/SubmissionAction.d.ts +1 -0
  116. package/dist/models/SubmissionAction.js +6 -0
  117. package/dist/models/SubmissionAction.js.map +1 -1
  118. package/dist/models/Template.d.ts +11 -0
  119. package/dist/models/Template.js +48 -0
  120. package/dist/models/Template.js.map +1 -1
  121. package/dist/models/TemplateType.d.ts +1 -0
  122. package/dist/models/TemplateType.js +2 -1
  123. package/dist/models/TemplateType.js.map +1 -1
  124. package/dist/models/UpdateAccountEmailActionRequest.d.ts +42 -0
  125. package/dist/models/UpdateAccountEmailActionRequest.js +131 -0
  126. package/dist/models/UpdateAccountEmailActionRequest.js.map +1 -0
  127. package/dist/models/UpdateEmailActionCustomizationRequest.d.ts +38 -0
  128. package/dist/models/UpdateEmailActionCustomizationRequest.js +107 -0
  129. package/dist/models/UpdateEmailActionCustomizationRequest.js.map +1 -0
  130. package/dist/models/UpdateEmailActionRequest.d.ts +40 -0
  131. package/dist/models/UpdateEmailActionRequest.js +119 -0
  132. package/dist/models/UpdateEmailActionRequest.js.map +1 -0
  133. package/dist/models/UpdateTemplateRequest.d.ts +11 -0
  134. package/dist/models/UpdateTemplateRequest.js +48 -0
  135. package/dist/models/UpdateTemplateRequest.js.map +1 -1
  136. package/dist/models/ValidateSubmissionRequest.d.ts +11 -0
  137. package/dist/models/ValidateSubmissionRequest.js +54 -0
  138. package/dist/models/ValidateSubmissionRequest.js.map +1 -1
  139. package/dist/models/WebhookEventType.d.ts +2 -0
  140. package/dist/models/WebhookEventType.js +2 -0
  141. package/dist/models/WebhookEventType.js.map +1 -1
  142. package/dist/models/all.d.ts +28 -0
  143. package/dist/models/all.js +28 -0
  144. package/dist/models/all.js.map +1 -1
  145. package/dist/types/ObjectParamAPI.d.ts +167 -0
  146. package/dist/types/ObjectParamAPI.js +182 -64
  147. package/dist/types/ObjectParamAPI.js.map +1 -1
  148. package/dist/types/ObservableAPI.d.ts +114 -64
  149. package/dist/types/ObservableAPI.js +819 -287
  150. package/dist/types/ObservableAPI.js.map +1 -1
  151. package/dist/types/PromiseAPI.d.ts +114 -64
  152. package/dist/types/PromiseAPI.js +318 -128
  153. package/dist/types/PromiseAPI.js.map +1 -1
  154. package/package.json +1 -1
package/README.md CHANGED
@@ -10,7 +10,7 @@ e-signatures.
10
10
  The code in this repository is generated from DocSpring's OpenAPI spec ([About this SDK](#about-this-sdk)). Issues and
11
11
  pull requests are welcome.
12
12
 
13
- Version 4.3.0.
13
+ Version 4.4.0.
14
14
 
15
15
  ## Install and configure
16
16
 
@@ -95,8 +95,11 @@ TypeScript code for every method.
95
95
  | ------ | ----------- |
96
96
  | [`addTemplateFields`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#addtemplatefields) | Add fields to a template |
97
97
  | [`copyTemplate`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#copytemplate) | Copy a template |
98
+ | [`createAccountEmailAction`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createaccountemailaction) | Create an account email action |
98
99
  | [`createCombinedPdf`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createcombinedpdf) | Combine PDFs |
99
100
  | [`createCustomFileFromUpload`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createcustomfilefromupload) | Create a custom file from an upload |
101
+ | [`createEmailAction`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createemailaction) | Create an email action |
102
+ | [`createEmailDomain`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createemaildomain) | Add an email domain |
100
103
  | [`createFolder`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createfolder) | Create a folder |
101
104
  | [`createSignatureRequestEvent`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createsignaturerequestevent) | Record a signature request event |
102
105
  | [`createSignatureRequestToken`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createsignaturerequesttoken) | Create a signature request token |
@@ -105,7 +108,11 @@ TypeScript code for every method.
105
108
  | [`createTemplate`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createtemplate) | Create a template |
106
109
  | [`createTemplatePreview`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createtemplatepreview) | Preview a template with data |
107
110
  | [`createWebhook`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createwebhook) | Create a webhook |
111
+ | [`deleteAccountEmailAction`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#deleteaccountemailaction) | Delete an account email action |
108
112
  | [`deleteCustomFile`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#deletecustomfile) | Delete a custom file |
113
+ | [`deleteEmailAction`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#deleteemailaction) | Delete an email action |
114
+ | [`deleteEmailActionCustomization`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#deleteemailactioncustomization) | Reset an account email action's customization |
115
+ | [`deleteEmailDomain`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#deleteemaildomain) | Remove an email domain |
109
116
  | [`deleteFolder`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#deletefolder) | Delete a folder |
110
117
  | [`deleteTemplate`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#deletetemplate) | Delete a template |
111
118
  | [`deleteWebhook`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#deletewebhook) | Delete a webhook |
@@ -113,8 +120,11 @@ TypeScript code for every method.
113
120
  | [`expireSubmission`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#expiresubmission) | Expire a submission |
114
121
  | [`generateSubmissionFiles`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#generatesubmissionfiles) | Generate more files |
115
122
  | [`generateSubmissionPreview`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#generatesubmissionpreview) | Generate a preview PDF |
123
+ | [`getAccountEmailAction`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getaccountemailaction) | Get an account email action |
116
124
  | [`getCombinedPdf`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getcombinedpdf) | Get a combined PDF |
117
125
  | [`getCustomFile`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getcustomfile) | Get a custom file |
126
+ | [`getEmailAction`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getemailaction) | Get an email action |
127
+ | [`getEmailDomain`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getemaildomain) | Get an email domain |
118
128
  | [`getFolder`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getfolder) | Get a folder |
119
129
  | [`getPresignUrl`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getpresignurl) | Get a presigned URL to upload a file |
120
130
  | [`getSignatureRequest`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getsignaturerequest) | Get a signature request |
@@ -127,8 +137,11 @@ TypeScript code for every method.
127
137
  | [`getTemplatePreview`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#gettemplatepreview) | Get a template preview |
128
138
  | [`getTemplateSchema`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#gettemplateschema) | Get the JSON Schema of a template's submission data |
129
139
  | [`getWebhook`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getwebhook) | Get a webhook |
140
+ | [`listAccountEmailActions`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listaccountemailactions) | List account email actions |
130
141
  | [`listCombinedPdfs`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listcombinedpdfs) | List combined PDFs |
131
142
  | [`listCustomFiles`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listcustomfiles) | List custom files |
143
+ | [`listEmailActions`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listemailactions) | List email actions |
144
+ | [`listEmailDomains`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listemaildomains) | List email domains |
132
145
  | [`listFolders`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listfolders) | List folders |
133
146
  | [`listSubmissions`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listsubmissions) | List submissions |
134
147
  | [`listTemplateFields`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listtemplatefields) | List a template's fields |
@@ -142,7 +155,12 @@ TypeScript code for every method.
142
155
  | [`renameFolder`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#renamefolder) | Rename a folder |
143
156
  | [`reorderTemplateFields`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#reordertemplatefields) | Reorder a template's fields |
144
157
  | [`restoreTemplateVersion`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#restoretemplateversion) | Restore a template version |
158
+ | [`sendAccountEmailActionTestEmail`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#sendaccountemailactiontestemail) | Send a test email for an account email action |
159
+ | [`sendEmailActionTestEmail`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#sendemailactiontestemail) | Send a test email |
145
160
  | [`testAuthentication`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#testauthentication) | Test authentication |
161
+ | [`updateAccountEmailAction`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updateaccountemailaction) | Update an account email action |
162
+ | [`updateEmailAction`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updateemailaction) | Update an email action |
163
+ | [`updateEmailActionCustomization`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updateemailactioncustomization) | Customize an account email action for a template |
146
164
  | [`updateSignatureRequest`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updatesignaturerequest) | Update a signature request |
147
165
  | [`updateTemplate`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updatetemplate) | Update a template |
148
166
  | [`updateTemplateDocument`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updatetemplatedocument) | Replace a template's document |
@@ -151,6 +169,7 @@ TypeScript code for every method.
151
169
  | [`uploadTemplate`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#uploadtemplate) | Create a template from an uploaded PDF or Word document |
152
170
  | [`uploadTemplateDocument`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#uploadtemplatedocument) | Replace a template's document with an uploaded file |
153
171
  | [`validateSubmission`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#validatesubmission) | Check a submission without creating it |
172
+ | [`verifyEmailDomain`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#verifyemaildomain) | Verify an email domain |
154
173
 
155
174
  ## Errors
156
175