docspring 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 (141) hide show
  1. package/README.md +20 -1
  2. package/dist/ApiClient.js +2 -2
  3. package/dist/RequestSchemas.js +1118 -93
  4. package/dist/RequestValidator.js +4 -0
  5. package/dist/api/Client.js +1360 -206
  6. package/dist/index.js +196 -0
  7. package/dist/model/AddTemplateFieldsRequest.js +3 -3
  8. package/dist/model/AuthenticationCheck.js +1 -1
  9. package/dist/model/CombinedPdf.js +1 -1
  10. package/dist/model/CombinedPdfFiles.js +1 -1
  11. package/dist/model/CombinedPdfList.js +1 -1
  12. package/dist/model/CombinedPdfSource.js +2 -2
  13. package/dist/model/CombinedPdfSourceInput.js +2 -2
  14. package/dist/model/CombinedPdfSourcePdf.js +1 -1
  15. package/dist/model/CopyTemplateRequest.js +1 -1
  16. package/dist/model/CreateAccountEmailActionRequest.js +306 -0
  17. package/dist/model/CreateCombinedPdfRequest.js +1 -1
  18. package/dist/model/CreateCustomFileFromUploadRequest.js +1 -1
  19. package/dist/model/CreateEmailActionRequest.js +280 -0
  20. package/dist/model/CreateEmailDomainRequest.js +114 -0
  21. package/dist/model/CreateFolderRequest.js +1 -1
  22. package/dist/model/CreateSignatureRequestEventRequest.js +1 -1
  23. package/dist/model/CreateSignatureRequestTokenRequest.js +1 -1
  24. package/dist/model/CreateSubmissionBatchRequest.js +4 -4
  25. package/dist/model/CreateSubmissionRequest.js +112 -4
  26. package/dist/model/CreateTemplatePreviewRequest.js +1 -1
  27. package/dist/model/CreateTemplateRequest.js +103 -8
  28. package/dist/model/CreateWebhookRequest.js +1 -1
  29. package/dist/model/CustomFile.js +1 -1
  30. package/dist/model/CustomFileList.js +1 -1
  31. package/dist/model/CustomFileSourcePdf.js +1 -1
  32. package/dist/model/DnsRecordType.js +64 -0
  33. package/dist/model/EmailAction.js +510 -0
  34. package/dist/model/EmailActionConditions.js +142 -0
  35. package/dist/model/EmailActionConditionsInput.js +142 -0
  36. package/dist/model/EmailActionCustomization.js +222 -0
  37. package/dist/model/EmailActionDelivery.js +59 -0
  38. package/dist/model/EmailActionFileFormats.js +69 -0
  39. package/dist/model/EmailActionList.js +132 -0
  40. package/dist/model/EmailActionSetting.js +119 -0
  41. package/dist/model/EmailActionSubmissionType.js +64 -0
  42. package/dist/model/EmailActionTestEmail.js +116 -0
  43. package/dist/model/EmailDomain.js +245 -0
  44. package/dist/model/EmailDomainDnsRecord.js +155 -0
  45. package/dist/model/EmailDomainDnsRecordPurpose.js +64 -0
  46. package/dist/model/EmailDomainList.js +132 -0
  47. package/dist/model/EmailDomainRecordState.js +64 -0
  48. package/dist/model/EmailDomainState.js +64 -0
  49. package/dist/model/ErrorCode.js +10 -0
  50. package/dist/model/ErrorDetail.js +1 -1
  51. package/dist/model/ErrorInfo.js +46 -7
  52. package/dist/model/ErrorResponse.js +1 -1
  53. package/dist/model/Field.js +3 -3
  54. package/dist/model/FieldComparisonCondition.js +1 -1
  55. package/dist/model/FieldDependency.js +1 -1
  56. package/dist/model/FieldDependencyInput.js +1 -1
  57. package/dist/model/FieldEqualsCondition.js +1 -1
  58. package/dist/model/FieldGroup.js +1 -1
  59. package/dist/model/FieldGroupInput.js +1 -1
  60. package/dist/model/FieldInCondition.js +1 -1
  61. package/dist/model/FieldInput.js +2 -2
  62. package/dist/model/FieldOverride.js +1 -1
  63. package/dist/model/FieldPresenceCondition.js +1 -1
  64. package/dist/model/FieldRangeCondition.js +1 -1
  65. package/dist/model/Folder.js +1 -1
  66. package/dist/model/FolderList.js +1 -1
  67. package/dist/model/GenerateSubmissionFilesRequest.js +1 -1
  68. package/dist/model/GeneratedFile.js +1 -1
  69. package/dist/model/HtmlEngineOptions.js +3 -3
  70. package/dist/model/HtmlEngineOptionsInput.js +2 -2
  71. package/dist/model/MoveFolderRequest.js +1 -1
  72. package/dist/model/MoveTemplateRequest.js +1 -1
  73. package/dist/model/PageImage.js +1 -1
  74. package/dist/model/PageImages.js +1 -1
  75. package/dist/model/PredefinedField.js +1 -1
  76. package/dist/model/PredefinedFieldInput.js +1 -1
  77. package/dist/model/PublishTemplateVersionRequest.js +1 -1
  78. package/dist/model/RemoveTemplateFieldsRequest.js +1 -1
  79. package/dist/model/RenameFolderRequest.js +1 -1
  80. package/dist/model/ReorderTemplateFieldsRequest.js +1 -1
  81. package/dist/model/RestoreTemplateVersionRequest.js +1 -1
  82. package/dist/model/SendAccountEmailActionTestEmailRequest.js +91 -0
  83. package/dist/model/SignatureRequest.js +52 -7
  84. package/dist/model/SignatureRequestEmailAttachments.js +59 -0
  85. package/dist/model/SignatureRequestEmailStatus.js +89 -0
  86. package/dist/model/SignatureRequestEvent.js +1 -1
  87. package/dist/model/SignatureRequestEventType.js +11 -1
  88. package/dist/model/SignatureRequestInput.js +24 -8
  89. package/dist/model/SignatureRequestReminders.js +121 -0
  90. package/dist/model/SignatureRequestToken.js +1 -1
  91. package/dist/model/SigningOrder.js +59 -0
  92. package/dist/model/StringConditionType.js +36 -1
  93. package/dist/model/Submission.js +21 -9
  94. package/dist/model/SubmissionAction.js +27 -12
  95. package/dist/model/SubmissionBatch.js +1 -1
  96. package/dist/model/SubmissionFiles.js +1 -1
  97. package/dist/model/SubmissionInput.js +4 -4
  98. package/dist/model/SubmissionList.js +1 -1
  99. package/dist/model/SubmissionSourcePdf.js +1 -1
  100. package/dist/model/SubmissionSummary.js +3 -3
  101. package/dist/model/SubmissionValidation.js +1 -1
  102. package/dist/model/Template.js +130 -19
  103. package/dist/model/TemplateActor.js +1 -1
  104. package/dist/model/TemplateDefaults.js +1 -1
  105. package/dist/model/TemplateDefaultsInput.js +1 -1
  106. package/dist/model/TemplateDiff.js +1 -1
  107. package/dist/model/TemplateDiffSummary.js +1 -1
  108. package/dist/model/TemplateDocument.js +1 -1
  109. package/dist/model/TemplateDocumentSummary.js +1 -1
  110. package/dist/model/TemplateFieldChange.js +1 -1
  111. package/dist/model/TemplateFieldChanges.js +1 -1
  112. package/dist/model/TemplateFieldDependency.js +1 -1
  113. package/dist/model/TemplateFieldDependencyCondition.js +1 -1
  114. package/dist/model/TemplateFieldDependencyConditionInput.js +1 -1
  115. package/dist/model/TemplateFieldDependencyInput.js +1 -1
  116. package/dist/model/TemplateFieldMove.js +1 -1
  117. package/dist/model/TemplateFields.js +1 -1
  118. package/dist/model/TemplateModelCode.js +1 -1
  119. package/dist/model/TemplatePageImages.js +1 -1
  120. package/dist/model/TemplatePageProcessingStatus.js +1 -1
  121. package/dist/model/TemplatePreview.js +1 -1
  122. package/dist/model/TemplateSourcePdf.js +2 -2
  123. package/dist/model/TemplateSummary.js +9 -9
  124. package/dist/model/TemplateSummaryList.js +1 -1
  125. package/dist/model/TemplateType.js +6 -1
  126. package/dist/model/TemplateVersion.js +1 -1
  127. package/dist/model/UpdateAccountEmailActionRequest.js +306 -0
  128. package/dist/model/UpdateEmailActionCustomizationRequest.js +258 -0
  129. package/dist/model/UpdateEmailActionRequest.js +280 -0
  130. package/dist/model/UpdateSignatureRequestRequest.js +1 -1
  131. package/dist/model/UpdateTemplateDocumentRequest.js +2 -2
  132. package/dist/model/UpdateTemplateFieldsRequest.js +1 -1
  133. package/dist/model/UpdateTemplateRequest.js +100 -5
  134. package/dist/model/UpdateWebhookRequest.js +1 -1
  135. package/dist/model/UploadPresign.js +1 -1
  136. package/dist/model/UrlSourcePdf.js +1 -1
  137. package/dist/model/ValidateSubmissionRequest.js +112 -4
  138. package/dist/model/Webhook.js +1 -1
  139. package/dist/model/WebhookEventType.js +10 -0
  140. package/dist/model/WebhookList.js +1 -1
  141. package/package.json +1 -1
@@ -61,4 +61,9 @@ _defineProperty(TemplateType, "html", "html");
61
61
  * value: "docx"
62
62
  * @const
63
63
  */
64
- _defineProperty(TemplateType, "docx", "docx");
64
+ _defineProperty(TemplateType, "docx", "docx");
65
+ /**
66
+ * value: "page_designer"
67
+ * @const
68
+ */
69
+ _defineProperty(TemplateType, "page_designer", "page_designer");
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The TemplateVersion model module.
32
32
  * @module model/TemplateVersion
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var TemplateVersion = /*#__PURE__*/function () {
36
36
  /**
@@ -0,0 +1,306 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ var _EmailActionConditionsInput = _interopRequireDefault(require("./EmailActionConditionsInput"));
9
+ var _EmailActionDelivery = _interopRequireDefault(require("./EmailActionDelivery"));
10
+ var _EmailActionFileFormats = _interopRequireDefault(require("./EmailActionFileFormats"));
11
+ var _EmailActionSubmissionType = _interopRequireDefault(require("./EmailActionSubmissionType"));
12
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
13
+ function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
14
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
15
+ function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
16
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
17
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
18
+ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
19
+ * DocSpring API
20
+ * Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
21
+ *
22
+ * The version of the OpenAPI document: v2
23
+ *
24
+ *
25
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
26
+ * https://openapi-generator.tech
27
+ * Do not edit the class manually.
28
+ *
29
+ */
30
+ /**
31
+ * The UpdateAccountEmailActionRequest model module.
32
+ * @module model/UpdateAccountEmailActionRequest
33
+ * @version 4.4.0
34
+ */
35
+ var UpdateAccountEmailActionRequest = /*#__PURE__*/function () {
36
+ /**
37
+ * Constructs a new <code>UpdateAccountEmailActionRequest</code>.
38
+ * The settings to change. Properties left out keep their values.
39
+ * @alias module:model/UpdateAccountEmailActionRequest
40
+ */
41
+ function UpdateAccountEmailActionRequest() {
42
+ _classCallCheck(this, UpdateAccountEmailActionRequest);
43
+ UpdateAccountEmailActionRequest.initialize(this);
44
+ }
45
+
46
+ /**
47
+ * Initializes the fields of this object.
48
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
49
+ * Only for internal use.
50
+ */
51
+ return _createClass(UpdateAccountEmailActionRequest, null, [{
52
+ key: "initialize",
53
+ value: function initialize(obj) {}
54
+
55
+ /**
56
+ * Constructs a <code>UpdateAccountEmailActionRequest</code> from a plain JavaScript object, optionally creating a new instance.
57
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
58
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
59
+ * @param {module:model/UpdateAccountEmailActionRequest} obj Optional instance to populate.
60
+ * @return {module:model/UpdateAccountEmailActionRequest} The populated <code>UpdateAccountEmailActionRequest</code> instance.
61
+ */
62
+ }, {
63
+ key: "constructFromObject",
64
+ value: function constructFromObject(data, obj) {
65
+ if (data) {
66
+ obj = obj || new UpdateAccountEmailActionRequest();
67
+ if (data.hasOwnProperty('template_ids')) {
68
+ obj['template_ids'] = _ApiClient["default"].convertToType(data['template_ids'], ['String']);
69
+ }
70
+ if (data.hasOwnProperty('folder_ids')) {
71
+ obj['folder_ids'] = _ApiClient["default"].convertToType(data['folder_ids'], ['String']);
72
+ }
73
+ if (data.hasOwnProperty('name')) {
74
+ obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
75
+ }
76
+ if (data.hasOwnProperty('enabled')) {
77
+ obj['enabled'] = _ApiClient["default"].convertToType(data['enabled'], 'Boolean');
78
+ }
79
+ if (data.hasOwnProperty('to')) {
80
+ obj['to'] = _ApiClient["default"].convertToType(data['to'], ['String']);
81
+ }
82
+ if (data.hasOwnProperty('cc')) {
83
+ obj['cc'] = _ApiClient["default"].convertToType(data['cc'], ['String']);
84
+ }
85
+ if (data.hasOwnProperty('bcc')) {
86
+ obj['bcc'] = _ApiClient["default"].convertToType(data['bcc'], ['String']);
87
+ }
88
+ if (data.hasOwnProperty('from_name')) {
89
+ obj['from_name'] = _ApiClient["default"].convertToType(data['from_name'], 'String');
90
+ }
91
+ if (data.hasOwnProperty('from_address')) {
92
+ obj['from_address'] = _ApiClient["default"].convertToType(data['from_address'], 'String');
93
+ }
94
+ if (data.hasOwnProperty('reply_to')) {
95
+ obj['reply_to'] = _ApiClient["default"].convertToType(data['reply_to'], 'String');
96
+ }
97
+ if (data.hasOwnProperty('subject')) {
98
+ obj['subject'] = _ApiClient["default"].convertToType(data['subject'], 'String');
99
+ }
100
+ if (data.hasOwnProperty('message')) {
101
+ obj['message'] = _ApiClient["default"].convertToType(data['message'], 'String');
102
+ }
103
+ if (data.hasOwnProperty('file_name')) {
104
+ obj['file_name'] = _ApiClient["default"].convertToType(data['file_name'], 'String');
105
+ }
106
+ if (data.hasOwnProperty('file_formats')) {
107
+ obj['file_formats'] = _ApiClient["default"].convertToType(data['file_formats'], _EmailActionFileFormats["default"]);
108
+ }
109
+ if (data.hasOwnProperty('delivery')) {
110
+ obj['delivery'] = _ApiClient["default"].convertToType(data['delivery'], _EmailActionDelivery["default"]);
111
+ }
112
+ if (data.hasOwnProperty('max_attachment_mb')) {
113
+ obj['max_attachment_mb'] = _ApiClient["default"].convertToType(data['max_attachment_mb'], 'Number');
114
+ }
115
+ if (data.hasOwnProperty('submission_type')) {
116
+ obj['submission_type'] = _ApiClient["default"].convertToType(data['submission_type'], _EmailActionSubmissionType["default"]);
117
+ }
118
+ if (data.hasOwnProperty('send_when')) {
119
+ obj['send_when'] = _ApiClient["default"].convertToType(data['send_when'], _EmailActionConditionsInput["default"]);
120
+ }
121
+ if (data.hasOwnProperty('failure_notifications_enabled')) {
122
+ obj['failure_notifications_enabled'] = _ApiClient["default"].convertToType(data['failure_notifications_enabled'], 'Boolean');
123
+ }
124
+ }
125
+ return obj;
126
+ }
127
+
128
+ /**
129
+ * Validates the JSON data with respect to <code>UpdateAccountEmailActionRequest</code>.
130
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
131
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>UpdateAccountEmailActionRequest</code>.
132
+ */
133
+ }, {
134
+ key: "validateJSON",
135
+ value: function validateJSON(data) {
136
+ // ensure the json data is an array
137
+ if (!Array.isArray(data['template_ids'])) {
138
+ throw new Error("Expected the field `template_ids` to be an array in the JSON data but got " + data['template_ids']);
139
+ }
140
+ // ensure the json data is an array
141
+ if (!Array.isArray(data['folder_ids'])) {
142
+ throw new Error("Expected the field `folder_ids` to be an array in the JSON data but got " + data['folder_ids']);
143
+ }
144
+ // ensure the json data is a string
145
+ if (data['name'] && !(typeof data['name'] === 'string' || data['name'] instanceof String)) {
146
+ throw new Error("Expected the field `name` to be a primitive type in the JSON string but got " + data['name']);
147
+ }
148
+ // ensure the json data is an array
149
+ if (!Array.isArray(data['to'])) {
150
+ throw new Error("Expected the field `to` to be an array in the JSON data but got " + data['to']);
151
+ }
152
+ // ensure the json data is an array
153
+ if (!Array.isArray(data['cc'])) {
154
+ throw new Error("Expected the field `cc` to be an array in the JSON data but got " + data['cc']);
155
+ }
156
+ // ensure the json data is an array
157
+ if (!Array.isArray(data['bcc'])) {
158
+ throw new Error("Expected the field `bcc` to be an array in the JSON data but got " + data['bcc']);
159
+ }
160
+ // ensure the json data is a string
161
+ if (data['from_name'] && !(typeof data['from_name'] === 'string' || data['from_name'] instanceof String)) {
162
+ throw new Error("Expected the field `from_name` to be a primitive type in the JSON string but got " + data['from_name']);
163
+ }
164
+ // ensure the json data is a string
165
+ if (data['from_address'] && !(typeof data['from_address'] === 'string' || data['from_address'] instanceof String)) {
166
+ throw new Error("Expected the field `from_address` to be a primitive type in the JSON string but got " + data['from_address']);
167
+ }
168
+ // ensure the json data is a string
169
+ if (data['reply_to'] && !(typeof data['reply_to'] === 'string' || data['reply_to'] instanceof String)) {
170
+ throw new Error("Expected the field `reply_to` to be a primitive type in the JSON string but got " + data['reply_to']);
171
+ }
172
+ // ensure the json data is a string
173
+ if (data['subject'] && !(typeof data['subject'] === 'string' || data['subject'] instanceof String)) {
174
+ throw new Error("Expected the field `subject` to be a primitive type in the JSON string but got " + data['subject']);
175
+ }
176
+ // ensure the json data is a string
177
+ if (data['message'] && !(typeof data['message'] === 'string' || data['message'] instanceof String)) {
178
+ throw new Error("Expected the field `message` to be a primitive type in the JSON string but got " + data['message']);
179
+ }
180
+ // ensure the json data is a string
181
+ if (data['file_name'] && !(typeof data['file_name'] === 'string' || data['file_name'] instanceof String)) {
182
+ throw new Error("Expected the field `file_name` to be a primitive type in the JSON string but got " + data['file_name']);
183
+ }
184
+ // validate the optional field `send_when`
185
+ if (data['send_when']) {
186
+ // data not null
187
+ _EmailActionConditionsInput["default"].validateJSON(data['send_when']);
188
+ }
189
+ return true;
190
+ }
191
+ }]);
192
+ }();
193
+ /**
194
+ * For an account email action: the IDs of the templates it sends for. With `folder_ids`, it sends for a template that either list includes. Both empty sends for every template. Always empty for a template's own email action.
195
+ * @member {Array.<String>} template_ids
196
+ */
197
+ UpdateAccountEmailActionRequest.prototype['template_ids'] = undefined;
198
+
199
+ /**
200
+ * For an account email action: the IDs of folders whose templates it sends for, including the templates in the folders inside them. Always empty for a template's own email action.
201
+ * @member {Array.<String>} folder_ids
202
+ */
203
+ UpdateAccountEmailActionRequest.prototype['folder_ids'] = undefined;
204
+
205
+ /**
206
+ * A name for the email action, shown in the dashboard. Null shows its recipients instead.
207
+ * @member {String} name
208
+ */
209
+ UpdateAccountEmailActionRequest.prototype['name'] = undefined;
210
+
211
+ /**
212
+ * Whether it sends emails. DocSpring turns an email action off after 3 days of failed emails, or straight away when one of the addresses in `to`, `cc` or `bcc` (not one from a field or metadata) bounces or marks an email as spam.
213
+ * @member {Boolean} enabled
214
+ */
215
+ UpdateAccountEmailActionRequest.prototype['enabled'] = undefined;
216
+
217
+ /**
218
+ * Who gets each email: email addresses, and tags for an address that each submission gives, from one of the template's text or email fields (`{{ data.client_email }}`, or `{{ data["client email"] }}` for a name with spaces) or from its metadata (`{{ metadata.agent_email }}`, or `{{ metadata.agent.email }}` for a value in an object). A tag whose value is blank or isn't a valid address is skipped for that submission, and so is a field an account email action names that the template doesn't have. `{{ signer.email }}` sends each of the submission's signers their own email, to them alone, and everyone else in `to`, `cc` and `bcc` one email together, without the signers. An email needs at least one entry in `to`, `cc` or `bcc`, and at most 10 across them.
219
+ * @member {Array.<String>} to
220
+ */
221
+ UpdateAccountEmailActionRequest.prototype['to'] = undefined;
222
+
223
+ /**
224
+ * Who is copied on each email, as in `to` (but not `{{ signer.email }}`).
225
+ * @member {Array.<String>} cc
226
+ */
227
+ UpdateAccountEmailActionRequest.prototype['cc'] = undefined;
228
+
229
+ /**
230
+ * Who is blind-copied on each email, as in `to` (but not `{{ signer.email }}`).
231
+ * @member {Array.<String>} bcc
232
+ */
233
+ UpdateAccountEmailActionRequest.prototype['bcc'] = undefined;
234
+
235
+ /**
236
+ * The sender's name. Null uses your account's name. From DocSpring's shared address, the name is followed by "via DocSpring".
237
+ * @member {String} from_name
238
+ */
239
+ UpdateAccountEmailActionRequest.prototype['from_name'] = undefined;
240
+
241
+ /**
242
+ * The sender's address, at one of your verified email domains. Null sends from DocSpring's shared address.
243
+ * @member {String} from_address
244
+ */
245
+ UpdateAccountEmailActionRequest.prototype['from_address'] = undefined;
246
+
247
+ /**
248
+ * Where replies go: a team member's email address, or an address at one of your verified email domains. Null sends without a reply address.
249
+ * @member {String} reply_to
250
+ */
251
+ UpdateAccountEmailActionRequest.prototype['reply_to'] = undefined;
252
+
253
+ /**
254
+ * The subject line, a Liquid template with the variables `account.name`, `template.name`, `template.id`, `submission.id`, the submission's values as `data.<field name>` (`data["field name"]` for a name with spaces) and its metadata as `metadata.<key>`, such as `Your {{ template.name }}`. Null uses the template's name followed by the file it sends, such as "Lease PDF", or by "files" when it sends several.
255
+ * @member {String} subject
256
+ */
257
+ UpdateAccountEmailActionRequest.prototype['subject'] = undefined;
258
+
259
+ /**
260
+ * The email's text, a Liquid template with the same variables as `subject`. `if`, `unless` and `case` tags work. Line breaks are kept. Null uses a short message that says the files are attached or ready to download.
261
+ * @member {String} message
262
+ */
263
+ UpdateAccountEmailActionRequest.prototype['message'] = undefined;
264
+
265
+ /**
266
+ * The attached files' name, a Liquid template with the same variables as `subject`, such as `{{ data.last_name }} lease`. Each file's extension (`.pdf`, `.docx` or `.odt`) is added. Null uses the submission's `pdf_filename` metadata when it has one, and otherwise the template's name. A download link's files have the names their other downloads have: the submission's `pdf_filename`, or its ID.
267
+ * @member {String} file_name
268
+ */
269
+ UpdateAccountEmailActionRequest.prototype['file_name'] = undefined;
270
+
271
+ /**
272
+ * Which of the submission's files the email sends: `all` sends every file the submission made (its PDF, and a Word template's Word document and OpenDocument file when it made them), and `docx`, `odt` or `pdf` sends only that file. A submission that made none of them sends nothing, and its email shows as skipped. Only Word templates make Word documents and OpenDocument files, so another template's email action takes `pdf` or `all`.
273
+ * @member {module:model/EmailActionFileFormats} file_formats
274
+ */
275
+ UpdateAccountEmailActionRequest.prototype['file_formats'] = undefined;
276
+
277
+ /**
278
+ * `attachment` attaches the files, or sends a download link when together they're larger than `max_attachment_mb`. `link` sends a download link, which works for 7 days. Accounts with a BAA start with `link`.
279
+ * @member {module:model/EmailActionDelivery} delivery
280
+ */
281
+ UpdateAccountEmailActionRequest.prototype['delivery'] = undefined;
282
+
283
+ /**
284
+ * With `delivery` `attachment`, files larger than this many megabytes in all (1 MB is 1,000,000 bytes) are sent as a download link instead. Emailing a file makes it about 38% larger, and many company mail servers refuse emails over 10 MB, so the default is 7. Raise it only when every recipient's mail server accepts larger emails, such as Microsoft 365 (up to 36 MB) or Gmail (50 MB).
285
+ * @member {Number} max_attachment_mb
286
+ */
287
+ UpdateAccountEmailActionRequest.prototype['max_attachment_mb'] = undefined;
288
+
289
+ /**
290
+ * Which submissions send emails: `live`, `test` or `all`. Test submissions only email your team's members, and skip every other recipient.
291
+ * @member {module:model/EmailActionSubmissionType} submission_type
292
+ */
293
+ UpdateAccountEmailActionRequest.prototype['submission_type'] = undefined;
294
+
295
+ /**
296
+ * Sends the email only when the submission's values meet these conditions, which work as a conditional logic rule's do. The values are the ones the PDF has: formulas worked out, and blank for a field that a rule hides. A field the template doesn't have (in an account email action's conditions) counts as blank. A submission that doesn't meet them sends nothing, and its email shows as skipped. Null sends for every submission.
297
+ * @member {module:model/EmailActionConditionsInput} send_when
298
+ */
299
+ UpdateAccountEmailActionRequest.prototype['send_when'] = undefined;
300
+
301
+ /**
302
+ * Whether the account's owner gets an email when the email action's emails keep failing.
303
+ * @member {Boolean} failure_notifications_enabled
304
+ */
305
+ UpdateAccountEmailActionRequest.prototype['failure_notifications_enabled'] = undefined;
306
+ var _default = exports["default"] = UpdateAccountEmailActionRequest;
@@ -0,0 +1,258 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ var _EmailActionConditionsInput = _interopRequireDefault(require("./EmailActionConditionsInput"));
9
+ var _EmailActionDelivery = _interopRequireDefault(require("./EmailActionDelivery"));
10
+ var _EmailActionFileFormats = _interopRequireDefault(require("./EmailActionFileFormats"));
11
+ var _EmailActionSubmissionType = _interopRequireDefault(require("./EmailActionSubmissionType"));
12
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
13
+ function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
14
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
15
+ function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
16
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
17
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
18
+ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
19
+ * DocSpring API
20
+ * Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
21
+ *
22
+ * The version of the OpenAPI document: v2
23
+ *
24
+ *
25
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
26
+ * https://openapi-generator.tech
27
+ * Do not edit the class manually.
28
+ *
29
+ */
30
+ /**
31
+ * The UpdateEmailActionCustomizationRequest model module.
32
+ * @module model/UpdateEmailActionCustomizationRequest
33
+ * @version 4.4.0
34
+ */
35
+ var UpdateEmailActionCustomizationRequest = /*#__PURE__*/function () {
36
+ /**
37
+ * Constructs a new <code>UpdateEmailActionCustomizationRequest</code>.
38
+ * The template's changes to the account email action, replacing any it had. Each setting you send is changed for this template, and the ones you leave out follow the account email action. `enabled: false` stops it sending for this template; left out, it sends.
39
+ * @alias module:model/UpdateEmailActionCustomizationRequest
40
+ */
41
+ function UpdateEmailActionCustomizationRequest() {
42
+ _classCallCheck(this, UpdateEmailActionCustomizationRequest);
43
+ UpdateEmailActionCustomizationRequest.initialize(this);
44
+ }
45
+
46
+ /**
47
+ * Initializes the fields of this object.
48
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
49
+ * Only for internal use.
50
+ */
51
+ return _createClass(UpdateEmailActionCustomizationRequest, null, [{
52
+ key: "initialize",
53
+ value: function initialize(obj) {}
54
+
55
+ /**
56
+ * Constructs a <code>UpdateEmailActionCustomizationRequest</code> from a plain JavaScript object, optionally creating a new instance.
57
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
58
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
59
+ * @param {module:model/UpdateEmailActionCustomizationRequest} obj Optional instance to populate.
60
+ * @return {module:model/UpdateEmailActionCustomizationRequest} The populated <code>UpdateEmailActionCustomizationRequest</code> instance.
61
+ */
62
+ }, {
63
+ key: "constructFromObject",
64
+ value: function constructFromObject(data, obj) {
65
+ if (data) {
66
+ obj = obj || new UpdateEmailActionCustomizationRequest();
67
+ if (data.hasOwnProperty('enabled')) {
68
+ obj['enabled'] = _ApiClient["default"].convertToType(data['enabled'], 'Boolean');
69
+ }
70
+ if (data.hasOwnProperty('to')) {
71
+ obj['to'] = _ApiClient["default"].convertToType(data['to'], ['String']);
72
+ }
73
+ if (data.hasOwnProperty('cc')) {
74
+ obj['cc'] = _ApiClient["default"].convertToType(data['cc'], ['String']);
75
+ }
76
+ if (data.hasOwnProperty('bcc')) {
77
+ obj['bcc'] = _ApiClient["default"].convertToType(data['bcc'], ['String']);
78
+ }
79
+ if (data.hasOwnProperty('from_name')) {
80
+ obj['from_name'] = _ApiClient["default"].convertToType(data['from_name'], 'String');
81
+ }
82
+ if (data.hasOwnProperty('from_address')) {
83
+ obj['from_address'] = _ApiClient["default"].convertToType(data['from_address'], 'String');
84
+ }
85
+ if (data.hasOwnProperty('reply_to')) {
86
+ obj['reply_to'] = _ApiClient["default"].convertToType(data['reply_to'], 'String');
87
+ }
88
+ if (data.hasOwnProperty('subject')) {
89
+ obj['subject'] = _ApiClient["default"].convertToType(data['subject'], 'String');
90
+ }
91
+ if (data.hasOwnProperty('message')) {
92
+ obj['message'] = _ApiClient["default"].convertToType(data['message'], 'String');
93
+ }
94
+ if (data.hasOwnProperty('file_name')) {
95
+ obj['file_name'] = _ApiClient["default"].convertToType(data['file_name'], 'String');
96
+ }
97
+ if (data.hasOwnProperty('file_formats')) {
98
+ obj['file_formats'] = _ApiClient["default"].convertToType(data['file_formats'], _EmailActionFileFormats["default"]);
99
+ }
100
+ if (data.hasOwnProperty('delivery')) {
101
+ obj['delivery'] = _ApiClient["default"].convertToType(data['delivery'], _EmailActionDelivery["default"]);
102
+ }
103
+ if (data.hasOwnProperty('max_attachment_mb')) {
104
+ obj['max_attachment_mb'] = _ApiClient["default"].convertToType(data['max_attachment_mb'], 'Number');
105
+ }
106
+ if (data.hasOwnProperty('submission_type')) {
107
+ obj['submission_type'] = _ApiClient["default"].convertToType(data['submission_type'], _EmailActionSubmissionType["default"]);
108
+ }
109
+ if (data.hasOwnProperty('send_when')) {
110
+ obj['send_when'] = _ApiClient["default"].convertToType(data['send_when'], _EmailActionConditionsInput["default"]);
111
+ }
112
+ }
113
+ return obj;
114
+ }
115
+
116
+ /**
117
+ * Validates the JSON data with respect to <code>UpdateEmailActionCustomizationRequest</code>.
118
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
119
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>UpdateEmailActionCustomizationRequest</code>.
120
+ */
121
+ }, {
122
+ key: "validateJSON",
123
+ value: function validateJSON(data) {
124
+ // ensure the json data is an array
125
+ if (!Array.isArray(data['to'])) {
126
+ throw new Error("Expected the field `to` to be an array in the JSON data but got " + data['to']);
127
+ }
128
+ // ensure the json data is an array
129
+ if (!Array.isArray(data['cc'])) {
130
+ throw new Error("Expected the field `cc` to be an array in the JSON data but got " + data['cc']);
131
+ }
132
+ // ensure the json data is an array
133
+ if (!Array.isArray(data['bcc'])) {
134
+ throw new Error("Expected the field `bcc` to be an array in the JSON data but got " + data['bcc']);
135
+ }
136
+ // ensure the json data is a string
137
+ if (data['from_name'] && !(typeof data['from_name'] === 'string' || data['from_name'] instanceof String)) {
138
+ throw new Error("Expected the field `from_name` to be a primitive type in the JSON string but got " + data['from_name']);
139
+ }
140
+ // ensure the json data is a string
141
+ if (data['from_address'] && !(typeof data['from_address'] === 'string' || data['from_address'] instanceof String)) {
142
+ throw new Error("Expected the field `from_address` to be a primitive type in the JSON string but got " + data['from_address']);
143
+ }
144
+ // ensure the json data is a string
145
+ if (data['reply_to'] && !(typeof data['reply_to'] === 'string' || data['reply_to'] instanceof String)) {
146
+ throw new Error("Expected the field `reply_to` to be a primitive type in the JSON string but got " + data['reply_to']);
147
+ }
148
+ // ensure the json data is a string
149
+ if (data['subject'] && !(typeof data['subject'] === 'string' || data['subject'] instanceof String)) {
150
+ throw new Error("Expected the field `subject` to be a primitive type in the JSON string but got " + data['subject']);
151
+ }
152
+ // ensure the json data is a string
153
+ if (data['message'] && !(typeof data['message'] === 'string' || data['message'] instanceof String)) {
154
+ throw new Error("Expected the field `message` to be a primitive type in the JSON string but got " + data['message']);
155
+ }
156
+ // ensure the json data is a string
157
+ if (data['file_name'] && !(typeof data['file_name'] === 'string' || data['file_name'] instanceof String)) {
158
+ throw new Error("Expected the field `file_name` to be a primitive type in the JSON string but got " + data['file_name']);
159
+ }
160
+ // validate the optional field `send_when`
161
+ if (data['send_when']) {
162
+ // data not null
163
+ _EmailActionConditionsInput["default"].validateJSON(data['send_when']);
164
+ }
165
+ return true;
166
+ }
167
+ }]);
168
+ }();
169
+ /**
170
+ * Whether it sends emails. DocSpring turns an email action off after 3 days of failed emails, or straight away when one of the addresses in `to`, `cc` or `bcc` (not one from a field or metadata) bounces or marks an email as spam.
171
+ * @member {Boolean} enabled
172
+ */
173
+ UpdateEmailActionCustomizationRequest.prototype['enabled'] = undefined;
174
+
175
+ /**
176
+ * Who gets each email: email addresses, and tags for an address that each submission gives, from one of the template's text or email fields (`{{ data.client_email }}`, or `{{ data["client email"] }}` for a name with spaces) or from its metadata (`{{ metadata.agent_email }}`, or `{{ metadata.agent.email }}` for a value in an object). A tag whose value is blank or isn't a valid address is skipped for that submission, and so is a field an account email action names that the template doesn't have. `{{ signer.email }}` sends each of the submission's signers their own email, to them alone, and everyone else in `to`, `cc` and `bcc` one email together, without the signers. An email needs at least one entry in `to`, `cc` or `bcc`, and at most 10 across them.
177
+ * @member {Array.<String>} to
178
+ */
179
+ UpdateEmailActionCustomizationRequest.prototype['to'] = undefined;
180
+
181
+ /**
182
+ * Who is copied on each email, as in `to` (but not `{{ signer.email }}`).
183
+ * @member {Array.<String>} cc
184
+ */
185
+ UpdateEmailActionCustomizationRequest.prototype['cc'] = undefined;
186
+
187
+ /**
188
+ * Who is blind-copied on each email, as in `to` (but not `{{ signer.email }}`).
189
+ * @member {Array.<String>} bcc
190
+ */
191
+ UpdateEmailActionCustomizationRequest.prototype['bcc'] = undefined;
192
+
193
+ /**
194
+ * The sender's name. Null uses your account's name. From DocSpring's shared address, the name is followed by "via DocSpring".
195
+ * @member {String} from_name
196
+ */
197
+ UpdateEmailActionCustomizationRequest.prototype['from_name'] = undefined;
198
+
199
+ /**
200
+ * The sender's address, at one of your verified email domains. Null sends from DocSpring's shared address.
201
+ * @member {String} from_address
202
+ */
203
+ UpdateEmailActionCustomizationRequest.prototype['from_address'] = undefined;
204
+
205
+ /**
206
+ * Where replies go: a team member's email address, or an address at one of your verified email domains. Null sends without a reply address.
207
+ * @member {String} reply_to
208
+ */
209
+ UpdateEmailActionCustomizationRequest.prototype['reply_to'] = undefined;
210
+
211
+ /**
212
+ * The subject line, a Liquid template with the variables `account.name`, `template.name`, `template.id`, `submission.id`, the submission's values as `data.<field name>` (`data["field name"]` for a name with spaces) and its metadata as `metadata.<key>`, such as `Your {{ template.name }}`. Null uses the template's name followed by the file it sends, such as "Lease PDF", or by "files" when it sends several.
213
+ * @member {String} subject
214
+ */
215
+ UpdateEmailActionCustomizationRequest.prototype['subject'] = undefined;
216
+
217
+ /**
218
+ * The email's text, a Liquid template with the same variables as `subject`. `if`, `unless` and `case` tags work. Line breaks are kept. Null uses a short message that says the files are attached or ready to download.
219
+ * @member {String} message
220
+ */
221
+ UpdateEmailActionCustomizationRequest.prototype['message'] = undefined;
222
+
223
+ /**
224
+ * The attached files' name, a Liquid template with the same variables as `subject`, such as `{{ data.last_name }} lease`. Each file's extension (`.pdf`, `.docx` or `.odt`) is added. Null uses the submission's `pdf_filename` metadata when it has one, and otherwise the template's name. A download link's files have the names their other downloads have: the submission's `pdf_filename`, or its ID.
225
+ * @member {String} file_name
226
+ */
227
+ UpdateEmailActionCustomizationRequest.prototype['file_name'] = undefined;
228
+
229
+ /**
230
+ * Which of the submission's files the email sends: `all` sends every file the submission made (its PDF, and a Word template's Word document and OpenDocument file when it made them), and `docx`, `odt` or `pdf` sends only that file. A submission that made none of them sends nothing, and its email shows as skipped. Only Word templates make Word documents and OpenDocument files, so another template's email action takes `pdf` or `all`.
231
+ * @member {module:model/EmailActionFileFormats} file_formats
232
+ */
233
+ UpdateEmailActionCustomizationRequest.prototype['file_formats'] = undefined;
234
+
235
+ /**
236
+ * `attachment` attaches the files, or sends a download link when together they're larger than `max_attachment_mb`. `link` sends a download link, which works for 7 days. Accounts with a BAA start with `link`.
237
+ * @member {module:model/EmailActionDelivery} delivery
238
+ */
239
+ UpdateEmailActionCustomizationRequest.prototype['delivery'] = undefined;
240
+
241
+ /**
242
+ * With `delivery` `attachment`, files larger than this many megabytes in all (1 MB is 1,000,000 bytes) are sent as a download link instead. Emailing a file makes it about 38% larger, and many company mail servers refuse emails over 10 MB, so the default is 7. Raise it only when every recipient's mail server accepts larger emails, such as Microsoft 365 (up to 36 MB) or Gmail (50 MB).
243
+ * @member {Number} max_attachment_mb
244
+ */
245
+ UpdateEmailActionCustomizationRequest.prototype['max_attachment_mb'] = undefined;
246
+
247
+ /**
248
+ * Which submissions send emails: `live`, `test` or `all`. Test submissions only email your team's members, and skip every other recipient.
249
+ * @member {module:model/EmailActionSubmissionType} submission_type
250
+ */
251
+ UpdateEmailActionCustomizationRequest.prototype['submission_type'] = undefined;
252
+
253
+ /**
254
+ * Sends the email only when the submission's values meet these conditions, which work as a conditional logic rule's do. The values are the ones the PDF has: formulas worked out, and blank for a field that a rule hides. A field the template doesn't have (in an account email action's conditions) counts as blank. A submission that doesn't meet them sends nothing, and its email shows as skipped. Null sends for every submission.
255
+ * @member {module:model/EmailActionConditionsInput} send_when
256
+ */
257
+ UpdateEmailActionCustomizationRequest.prototype['send_when'] = undefined;
258
+ var _default = exports["default"] = UpdateEmailActionCustomizationRequest;