@formalingo/sdk 0.1.3 → 0.1.4

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 (166) hide show
  1. package/README.md +31 -9
  2. package/dist/client/api/v1/analytics/index.d.ts +20 -0
  3. package/dist/client/api/v1/analytics/index.d.ts.map +1 -0
  4. package/dist/client/api/v1/analytics/index.js +20 -0
  5. package/dist/client/api/v1/analytics/index.js.map +1 -0
  6. package/dist/client/api/v1/analytics/summary/index.d.ts +131 -0
  7. package/dist/client/api/v1/analytics/summary/index.d.ts.map +1 -0
  8. package/dist/client/api/v1/analytics/summary/index.js +137 -0
  9. package/dist/client/api/v1/analytics/summary/index.js.map +1 -0
  10. package/dist/client/api/v1/deliveries/index.d.ts +192 -0
  11. package/dist/client/api/v1/deliveries/index.d.ts.map +1 -0
  12. package/dist/client/api/v1/deliveries/index.js +189 -0
  13. package/dist/client/api/v1/deliveries/index.js.map +1 -0
  14. package/dist/client/api/v1/documents/importEscaped/index.d.ts +144 -0
  15. package/dist/client/api/v1/documents/importEscaped/index.d.ts.map +1 -0
  16. package/dist/client/api/v1/documents/importEscaped/index.js +153 -0
  17. package/dist/client/api/v1/documents/importEscaped/index.js.map +1 -0
  18. package/dist/client/api/v1/documents/index.d.ts +5 -0
  19. package/dist/client/api/v1/documents/index.d.ts.map +1 -1
  20. package/dist/client/api/v1/documents/index.js +5 -0
  21. package/dist/client/api/v1/documents/index.js.map +1 -1
  22. package/dist/client/api/v1/documents/item/exportEscaped/index.d.ts +103 -0
  23. package/dist/client/api/v1/documents/item/exportEscaped/index.d.ts.map +1 -0
  24. package/dist/client/api/v1/documents/item/exportEscaped/index.js +102 -0
  25. package/dist/client/api/v1/documents/item/exportEscaped/index.js.map +1 -0
  26. package/dist/client/api/v1/documents/item/fields/index.d.ts +121 -7
  27. package/dist/client/api/v1/documents/item/fields/index.d.ts.map +1 -1
  28. package/dist/client/api/v1/documents/item/fields/index.js +125 -0
  29. package/dist/client/api/v1/documents/item/fields/index.js.map +1 -1
  30. package/dist/client/api/v1/documents/item/fields/item/index.d.ts +106 -16
  31. package/dist/client/api/v1/documents/item/fields/item/index.d.ts.map +1 -1
  32. package/dist/client/api/v1/documents/item/fields/item/index.js +97 -4
  33. package/dist/client/api/v1/documents/item/fields/item/index.js.map +1 -1
  34. package/dist/client/api/v1/documents/item/index.d.ts +104 -6
  35. package/dist/client/api/v1/documents/item/index.d.ts.map +1 -1
  36. package/dist/client/api/v1/documents/item/index.js +111 -4
  37. package/dist/client/api/v1/documents/item/index.js.map +1 -1
  38. package/dist/client/api/v1/documents/item/parseJobs/index.d.ts +155 -0
  39. package/dist/client/api/v1/documents/item/parseJobs/index.d.ts.map +1 -0
  40. package/dist/client/api/v1/documents/item/parseJobs/index.js +163 -0
  41. package/dist/client/api/v1/documents/item/parseJobs/index.js.map +1 -0
  42. package/dist/client/api/v1/documents/item/parseJobs/item/apply/index.d.ts +180 -0
  43. package/dist/client/api/v1/documents/item/parseJobs/item/apply/index.d.ts.map +1 -0
  44. package/dist/client/api/v1/documents/item/parseJobs/item/apply/index.js +189 -0
  45. package/dist/client/api/v1/documents/item/parseJobs/item/apply/index.js.map +1 -0
  46. package/dist/client/api/v1/documents/item/parseJobs/item/index.d.ts +75 -0
  47. package/dist/client/api/v1/documents/item/parseJobs/item/index.d.ts.map +1 -0
  48. package/dist/client/api/v1/documents/item/parseJobs/item/index.js +76 -0
  49. package/dist/client/api/v1/documents/item/parseJobs/item/index.js.map +1 -0
  50. package/dist/client/api/v1/documents/item/publish/index.d.ts +200 -0
  51. package/dist/client/api/v1/documents/item/publish/index.d.ts.map +1 -0
  52. package/dist/client/api/v1/documents/item/publish/index.js +220 -0
  53. package/dist/client/api/v1/documents/item/publish/index.js.map +1 -0
  54. package/dist/client/api/v1/documents/item/revisions/index.d.ts +112 -0
  55. package/dist/client/api/v1/documents/item/revisions/index.d.ts.map +1 -0
  56. package/dist/client/api/v1/documents/item/revisions/index.js +110 -0
  57. package/dist/client/api/v1/documents/item/revisions/index.js.map +1 -0
  58. package/dist/client/api/v1/documents/item/revisions/item/index.d.ts +95 -0
  59. package/dist/client/api/v1/documents/item/revisions/item/index.d.ts.map +1 -0
  60. package/dist/client/api/v1/documents/item/revisions/item/index.js +102 -0
  61. package/dist/client/api/v1/documents/item/revisions/item/index.js.map +1 -0
  62. package/dist/client/api/v1/documents/item/signerRoles/index.d.ts +1 -0
  63. package/dist/client/api/v1/documents/item/signerRoles/index.d.ts.map +1 -1
  64. package/dist/client/api/v1/documents/item/signerRoles/index.js +4 -1
  65. package/dist/client/api/v1/documents/item/signerRoles/index.js.map +1 -1
  66. package/dist/client/api/v1/documents/item/signerRoles/item/index.d.ts +121 -1
  67. package/dist/client/api/v1/documents/item/signerRoles/item/index.d.ts.map +1 -1
  68. package/dist/client/api/v1/documents/item/signerRoles/item/index.js +133 -0
  69. package/dist/client/api/v1/documents/item/signerRoles/item/index.js.map +1 -1
  70. package/dist/client/api/v1/documents/item/submissions/index.d.ts +40 -30
  71. package/dist/client/api/v1/documents/item/submissions/index.d.ts.map +1 -1
  72. package/dist/client/api/v1/documents/item/submissions/index.js +36 -28
  73. package/dist/client/api/v1/documents/item/submissions/index.js.map +1 -1
  74. package/dist/client/api/v1/documents/item/submissions/item/expire/index.d.ts +280 -0
  75. package/dist/client/api/v1/documents/item/submissions/item/expire/index.d.ts.map +1 -0
  76. package/dist/client/api/v1/documents/item/submissions/item/expire/index.js +301 -0
  77. package/dist/client/api/v1/documents/item/submissions/item/expire/index.js.map +1 -0
  78. package/dist/client/api/v1/documents/item/submissions/item/index.d.ts +86 -1
  79. package/dist/client/api/v1/documents/item/submissions/item/index.d.ts.map +1 -1
  80. package/dist/client/api/v1/documents/item/submissions/item/index.js +92 -0
  81. package/dist/client/api/v1/documents/item/submissions/item/index.js.map +1 -1
  82. package/dist/client/api/v1/documents/item/submissions/item/pdf/index.d.ts +42 -0
  83. package/dist/client/api/v1/documents/item/submissions/item/pdf/index.d.ts.map +1 -1
  84. package/dist/client/api/v1/documents/item/submissions/item/pdf/index.js +43 -0
  85. package/dist/client/api/v1/documents/item/submissions/item/pdf/index.js.map +1 -1
  86. package/dist/client/api/v1/documents/item/submissions/item/signers/item/index.d.ts +5 -41
  87. package/dist/client/api/v1/documents/item/submissions/item/signers/item/index.d.ts.map +1 -1
  88. package/dist/client/api/v1/documents/item/submissions/item/signers/item/index.js +7 -44
  89. package/dist/client/api/v1/documents/item/submissions/item/signers/item/index.js.map +1 -1
  90. package/dist/client/api/v1/documents/item/submissions/item/signers/item/responses/index.d.ts +7 -2
  91. package/dist/client/api/v1/documents/item/submissions/item/signers/item/responses/index.d.ts.map +1 -1
  92. package/dist/client/api/v1/documents/item/submissions/item/signers/item/responses/index.js +5 -0
  93. package/dist/client/api/v1/documents/item/submissions/item/signers/item/responses/index.js.map +1 -1
  94. package/dist/client/api/v1/files/index.d.ts +22 -0
  95. package/dist/client/api/v1/files/index.d.ts.map +1 -0
  96. package/dist/client/api/v1/files/index.js +21 -0
  97. package/dist/client/api/v1/files/index.js.map +1 -0
  98. package/dist/client/api/v1/files/item/download/index.d.ts +180 -0
  99. package/dist/client/api/v1/files/item/download/index.d.ts.map +1 -0
  100. package/dist/client/api/v1/files/item/download/index.js +189 -0
  101. package/dist/client/api/v1/files/item/download/index.js.map +1 -0
  102. package/dist/client/api/v1/files/item/index.d.ts +20 -0
  103. package/dist/client/api/v1/files/item/index.d.ts.map +1 -0
  104. package/dist/client/api/v1/files/item/index.js +20 -0
  105. package/dist/client/api/v1/files/item/index.js.map +1 -0
  106. package/dist/client/api/v1/forms/index.d.ts +46 -1
  107. package/dist/client/api/v1/forms/index.d.ts.map +1 -1
  108. package/dist/client/api/v1/forms/index.js +22 -1
  109. package/dist/client/api/v1/forms/index.js.map +1 -1
  110. package/dist/client/api/v1/forms/item/index.d.ts +18 -0
  111. package/dist/client/api/v1/forms/item/index.d.ts.map +1 -1
  112. package/dist/client/api/v1/forms/item/index.js +15 -0
  113. package/dist/client/api/v1/forms/item/index.js.map +1 -1
  114. package/dist/client/api/v1/forms/item/publish/index.d.ts +200 -0
  115. package/dist/client/api/v1/forms/item/publish/index.d.ts.map +1 -0
  116. package/dist/client/api/v1/forms/item/publish/index.js +220 -0
  117. package/dist/client/api/v1/forms/item/publish/index.js.map +1 -0
  118. package/dist/client/api/v1/forms/item/recipients/bulk/index.d.ts +274 -0
  119. package/dist/client/api/v1/forms/item/recipients/bulk/index.d.ts.map +1 -0
  120. package/dist/client/api/v1/forms/item/recipients/bulk/index.js +302 -0
  121. package/dist/client/api/v1/forms/item/recipients/bulk/index.js.map +1 -0
  122. package/dist/client/api/v1/forms/item/recipients/index.d.ts +10 -4
  123. package/dist/client/api/v1/forms/item/recipients/index.d.ts.map +1 -1
  124. package/dist/client/api/v1/forms/item/recipients/index.js +11 -3
  125. package/dist/client/api/v1/forms/item/recipients/index.js.map +1 -1
  126. package/dist/client/api/v1/forms/item/recipients/item/index.d.ts +3 -2
  127. package/dist/client/api/v1/forms/item/recipients/item/index.d.ts.map +1 -1
  128. package/dist/client/api/v1/forms/item/recipients/item/index.js +6 -3
  129. package/dist/client/api/v1/forms/item/recipients/item/index.js.map +1 -1
  130. package/dist/client/api/v1/forms/item/recipients/item/responses/index.d.ts +4 -0
  131. package/dist/client/api/v1/forms/item/recipients/item/responses/index.d.ts.map +1 -1
  132. package/dist/client/api/v1/forms/item/recipients/item/responses/index.js +2 -0
  133. package/dist/client/api/v1/forms/item/recipients/item/responses/index.js.map +1 -1
  134. package/dist/client/api/v1/forms/item/revisions/index.d.ts +112 -0
  135. package/dist/client/api/v1/forms/item/revisions/index.d.ts.map +1 -0
  136. package/dist/client/api/v1/forms/item/revisions/index.js +110 -0
  137. package/dist/client/api/v1/forms/item/revisions/index.js.map +1 -0
  138. package/dist/client/api/v1/forms/item/revisions/item/index.d.ts +95 -0
  139. package/dist/client/api/v1/forms/item/revisions/item/index.d.ts.map +1 -0
  140. package/dist/client/api/v1/forms/item/revisions/item/index.js +102 -0
  141. package/dist/client/api/v1/forms/item/revisions/item/index.js.map +1 -0
  142. package/dist/client/api/v1/index.d.ts +25 -0
  143. package/dist/client/api/v1/index.d.ts.map +1 -1
  144. package/dist/client/api/v1/index.js +25 -0
  145. package/dist/client/api/v1/index.js.map +1 -1
  146. package/dist/client/api/v1/integrations/index.d.ts +20 -0
  147. package/dist/client/api/v1/integrations/index.d.ts.map +1 -0
  148. package/dist/client/api/v1/integrations/index.js +20 -0
  149. package/dist/client/api/v1/integrations/index.js.map +1 -0
  150. package/dist/client/api/v1/integrations/status/index.d.ts +168 -0
  151. package/dist/client/api/v1/integrations/status/index.d.ts.map +1 -0
  152. package/dist/client/api/v1/integrations/status/index.js +177 -0
  153. package/dist/client/api/v1/integrations/status/index.js.map +1 -0
  154. package/dist/client/api/v1/quota/index.d.ts +93 -0
  155. package/dist/client/api/v1/quota/index.d.ts.map +1 -0
  156. package/dist/client/api/v1/quota/index.js +99 -0
  157. package/dist/client/api/v1/quota/index.js.map +1 -0
  158. package/dist/client/models/index.d.ts +1961 -137
  159. package/dist/client/models/index.d.ts.map +1 -1
  160. package/dist/client/models/index.js +2001 -211
  161. package/dist/client/models/index.js.map +1 -1
  162. package/dist/index.d.ts +15 -0
  163. package/dist/index.d.ts.map +1 -1
  164. package/dist/index.js +89 -1
  165. package/dist/index.js.map +1 -1
  166. package/package.json +1 -1
@@ -1,4 +1,68 @@
1
- import { type AdditionalDataHolder, type Guid, type Parsable, type ParseNode, type SerializationWriter, type UntypedNode } from '@microsoft/kiota-abstractions';
1
+ import { type AdditionalDataHolder, type ApiError, type Guid, type Parsable, type ParseNode, type SerializationWriter, type UntypedNode } from '@microsoft/kiota-abstractions';
2
+ export interface ApplyDocumentParseJobResponse extends AdditionalDataHolder, Parsable {
3
+ /**
4
+ * The data property
5
+ */
6
+ data?: ParseJobAppliedResult | null;
7
+ /**
8
+ * The meta property
9
+ */
10
+ meta?: ApplyDocumentParseJobResponse_meta | null;
11
+ /**
12
+ * The success property
13
+ */
14
+ success?: boolean | null;
15
+ }
16
+ export interface ApplyDocumentParseJobResponse_meta extends AdditionalDataHolder, Parsable {
17
+ /**
18
+ * The limit property
19
+ */
20
+ limit?: number | null;
21
+ /**
22
+ * The page property
23
+ */
24
+ page?: number | null;
25
+ /**
26
+ * Total number of records
27
+ */
28
+ total?: number | null;
29
+ }
30
+ export interface CanonicalDocumentSubmission extends DocumentSubmission, Parsable {
31
+ }
32
+ export interface CanonicalRecipient extends Parsable, Recipient {
33
+ }
34
+ export interface CanonicalSigner extends Parsable, Signer {
35
+ }
36
+ /**
37
+ * Creates a new instance of the appropriate class based on discriminator value
38
+ * @param parseNode The parse node to use to read the discriminator value and create the object
39
+ * @returns {ApplyDocumentParseJobResponse_meta}
40
+ */
41
+ export declare function createApplyDocumentParseJobResponse_metaFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
42
+ /**
43
+ * Creates a new instance of the appropriate class based on discriminator value
44
+ * @param parseNode The parse node to use to read the discriminator value and create the object
45
+ * @returns {ApplyDocumentParseJobResponse}
46
+ */
47
+ export declare function createApplyDocumentParseJobResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
48
+ /**
49
+ * Creates a new instance of the appropriate class based on discriminator value
50
+ * @param parseNode The parse node to use to read the discriminator value and create the object
51
+ * @returns {CanonicalDocumentSubmission}
52
+ */
53
+ export declare function createCanonicalDocumentSubmissionFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
54
+ /**
55
+ * Creates a new instance of the appropriate class based on discriminator value
56
+ * @param parseNode The parse node to use to read the discriminator value and create the object
57
+ * @returns {CanonicalRecipient}
58
+ */
59
+ export declare function createCanonicalRecipientFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
60
+ /**
61
+ * Creates a new instance of the appropriate class based on discriminator value
62
+ * @param parseNode The parse node to use to read the discriminator value and create the object
63
+ * @returns {CanonicalSigner}
64
+ */
65
+ export declare function createCanonicalSignerFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
2
66
  /**
3
67
  * Creates a new instance of the appropriate class based on discriminator value
4
68
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -53,6 +117,36 @@ export declare function createCreateSignerRoleBodyFromDiscriminatorValue(parseNo
53
117
  * @returns {CreateSubmissionBody}
54
118
  */
55
119
  export declare function createCreateSubmissionBodyFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
120
+ /**
121
+ * Creates a new instance of the appropriate class based on discriminator value
122
+ * @param parseNode The parse node to use to read the discriminator value and create the object
123
+ * @returns {CreateSubmissionResponse}
124
+ */
125
+ export declare function createCreateSubmissionResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
126
+ /**
127
+ * Creates a new instance of the appropriate class based on discriminator value
128
+ * @param parseNode The parse node to use to read the discriminator value and create the object
129
+ * @returns {CreateSubmissionResult}
130
+ */
131
+ export declare function createCreateSubmissionResultFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
132
+ /**
133
+ * Creates a new instance of the appropriate class based on discriminator value
134
+ * @param parseNode The parse node to use to read the discriminator value and create the object
135
+ * @returns {CreateSubmissionSignerResult}
136
+ */
137
+ export declare function createCreateSubmissionSignerResultFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
138
+ /**
139
+ * Creates a new instance of the appropriate class based on discriminator value
140
+ * @param parseNode The parse node to use to read the discriminator value and create the object
141
+ * @returns {DetectedDocumentField_rect}
142
+ */
143
+ export declare function createDetectedDocumentField_rectFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
144
+ /**
145
+ * Creates a new instance of the appropriate class based on discriminator value
146
+ * @param parseNode The parse node to use to read the discriminator value and create the object
147
+ * @returns {DetectedDocumentField}
148
+ */
149
+ export declare function createDetectedDocumentFieldFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
56
150
  /**
57
151
  * Creates a new instance of the appropriate class based on discriminator value
58
152
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -77,12 +171,45 @@ export declare function createDocumentFieldFromDiscriminatorValue(parseNode: Par
77
171
  * @returns {Document}
78
172
  */
79
173
  export declare function createDocumentFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
174
+ /**
175
+ * Creates a new instance of the appropriate class based on discriminator value
176
+ * @param parseNode The parse node to use to read the discriminator value and create the object
177
+ * @returns {DocumentNotEditableConflict}
178
+ */
179
+ export declare function createDocumentNotEditableConflictFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
180
+ /**
181
+ * Creates a new instance of the appropriate class based on discriminator value
182
+ * @param parseNode The parse node to use to read the discriminator value and create the object
183
+ * @returns {DocumentParseJobResult_stats}
184
+ */
185
+ export declare function createDocumentParseJobResult_statsFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
186
+ /**
187
+ * Creates a new instance of the appropriate class based on discriminator value
188
+ * @param parseNode The parse node to use to read the discriminator value and create the object
189
+ * @returns {DocumentParseJobResult}
190
+ */
191
+ export declare function createDocumentParseJobResultFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
192
+ /**
193
+ * Creates a new instance of the appropriate class based on discriminator value
194
+ * @param parseNode The parse node to use to read the discriminator value and create the object
195
+ * @returns {DocumentRevision}
196
+ */
197
+ export declare function createDocumentRevisionFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
198
+ /**
199
+ * Creates a new instance of the appropriate class based on discriminator value
200
+ * @param parseNode The parse node to use to read the discriminator value and create the object
201
+ * @returns {DocumentSubmission_signedPdf}
202
+ */
203
+ export declare function createDocumentSubmission_signedPdfFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
80
204
  /**
81
205
  * Creates a new instance of the appropriate class based on discriminator value
82
206
  * @param parseNode The parse node to use to read the discriminator value and create the object
83
207
  * @returns {DocumentSubmission}
84
208
  */
85
209
  export declare function createDocumentSubmissionFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
210
+ /**
211
+ * Create a placed field or a supporting file_upload request. Supporting requests require options.supporting_attachment=true and an assigned signer; omitted geometry is canonicalized to all zero and Required defaults to true. Ordinary fields require complete page placement. Field purpose is immutable after creation.
212
+ */
86
213
  export interface CreateFieldBody extends AdditionalDataHolder, Parsable {
87
214
  /**
88
215
  * The assigneeRole property
@@ -97,15 +224,19 @@ export interface CreateFieldBody extends AdditionalDataHolder, Parsable {
97
224
  */
98
225
  direction?: CreateFieldBody_direction | null;
99
226
  /**
100
- * The height property
227
+ * Required and positive for placed fields. Omit or use 0 for a supporting attachment request.
101
228
  */
102
229
  height?: number | null;
103
230
  /**
104
- * The isReadOnly property
231
+ * Optional client UUID for retry-safe supporting attachment creation. Reusing the same UUID and request returns the original field; conflicting reuse returns 409. Not supported for placed fields.
232
+ */
233
+ id?: Guid | null;
234
+ /**
235
+ * Supporting attachment requests must remain writable.
105
236
  */
106
237
  isReadOnly?: boolean | null;
107
238
  /**
108
- * The isRequired property
239
+ * Defaults to true for supporting attachment requests and false for ordinary placed fields.
109
240
  */
110
241
  isRequired?: boolean | null;
111
242
  /**
@@ -113,15 +244,15 @@ export interface CreateFieldBody extends AdditionalDataHolder, Parsable {
113
244
  */
114
245
  label?: string | null;
115
246
  /**
116
- * The options property
247
+ * Type-specific options, including additional options supported by the field type. For calculation fields, use formula and result_type (text or number).
117
248
  */
118
249
  options?: CreateFieldBody_options | null;
119
250
  /**
120
- * The order property
251
+ * Field order. For supporting attachment requests, the value must be between 0 and 1,000,000 inclusive.
121
252
  */
122
253
  order?: number | null;
123
254
  /**
124
- * The pageNumber property
255
+ * Required and at least 1 for placed fields. Omit or use 0 for a supporting attachment request.
125
256
  */
126
257
  pageNumber?: number | null;
127
258
  /**
@@ -129,22 +260,47 @@ export interface CreateFieldBody extends AdditionalDataHolder, Parsable {
129
260
  */
130
261
  type?: CreateFieldBody_type | null;
131
262
  /**
132
- * The width property
263
+ * Required and positive for placed fields. Omit or use 0 for a supporting attachment request.
133
264
  */
134
265
  width?: number | null;
135
266
  /**
136
- * The x property
267
+ * Required for placed fields. Omit or use 0 for a supporting attachment request.
137
268
  */
138
269
  x?: number | null;
139
270
  /**
140
- * The y property
271
+ * Required for placed fields. Omit or use 0 for a supporting attachment request.
141
272
  */
142
273
  y?: number | null;
143
274
  }
144
275
  export type CreateFieldBody_direction = (typeof CreateFieldBody_directionObject)[keyof typeof CreateFieldBody_directionObject];
276
+ /**
277
+ * Type-specific options, including additional options supported by the field type. For calculation fields, use formula and result_type (text or number).
278
+ */
145
279
  export interface CreateFieldBody_options extends AdditionalDataHolder, Parsable {
280
+ /**
281
+ * Set true for a supporting upload request excluded from the document and signed PDF. Only file_upload supports this flag; false and changing the field purpose after creation are rejected.
282
+ */
283
+ supportingAttachment?: boolean | null;
146
284
  }
147
285
  export type CreateFieldBody_type = (typeof CreateFieldBody_typeObject)[keyof typeof CreateFieldBody_typeObject];
286
+ /**
287
+ * Creates a new instance of the appropriate class based on discriminator value
288
+ * @param parseNode The parse node to use to read the discriminator value and create the object
289
+ * @returns {FileDescriptor}
290
+ */
291
+ export declare function createFileDescriptorFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
292
+ /**
293
+ * Creates a new instance of the appropriate class based on discriminator value
294
+ * @param parseNode The parse node to use to read the discriminator value and create the object
295
+ * @returns {FileDownload}
296
+ */
297
+ export declare function createFileDownloadFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
298
+ /**
299
+ * Creates a new instance of the appropriate class based on discriminator value
300
+ * @param parseNode The parse node to use to read the discriminator value and create the object
301
+ * @returns {FileDownloadResponse}
302
+ */
303
+ export declare function createFileDownloadResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
148
304
  /**
149
305
  * Creates a new instance of the appropriate class based on discriminator value
150
306
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -173,6 +329,66 @@ export interface CreateFormBody extends AdditionalDataHolder, Parsable {
173
329
  * @returns {Form}
174
330
  */
175
331
  export declare function createFormFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
332
+ /**
333
+ * Creates a new instance of the appropriate class based on discriminator value
334
+ * @param parseNode The parse node to use to read the discriminator value and create the object
335
+ * @returns {FormRevision}
336
+ */
337
+ export declare function createFormRevisionFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
338
+ /**
339
+ * Creates a new instance of the appropriate class based on discriminator value
340
+ * @param parseNode The parse node to use to read the discriminator value and create the object
341
+ * @returns {GetDocumentParseJobResponse_data}
342
+ */
343
+ export declare function createGetDocumentParseJobResponse_dataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
344
+ /**
345
+ * Creates a new instance of the appropriate class based on discriminator value
346
+ * @param parseNode The parse node to use to read the discriminator value and create the object
347
+ * @returns {GetDocumentParseJobResponse_meta}
348
+ */
349
+ export declare function createGetDocumentParseJobResponse_metaFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
350
+ /**
351
+ * Creates a new instance of the appropriate class based on discriminator value
352
+ * @param parseNode The parse node to use to read the discriminator value and create the object
353
+ * @returns {GetDocumentParseJobResponse}
354
+ */
355
+ export declare function createGetDocumentParseJobResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
356
+ /**
357
+ * Creates a new instance of the appropriate class based on discriminator value
358
+ * @param parseNode The parse node to use to read the discriminator value and create the object
359
+ * @returns {ImportDocumentBundleResponse_data}
360
+ */
361
+ export declare function createImportDocumentBundleResponse_dataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
362
+ /**
363
+ * Creates a new instance of the appropriate class based on discriminator value
364
+ * @param parseNode The parse node to use to read the discriminator value and create the object
365
+ * @returns {ImportDocumentBundleResponse_meta}
366
+ */
367
+ export declare function createImportDocumentBundleResponse_metaFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
368
+ /**
369
+ * Creates a new instance of the appropriate class based on discriminator value
370
+ * @param parseNode The parse node to use to read the discriminator value and create the object
371
+ * @returns {ImportDocumentBundleResponse}
372
+ */
373
+ export declare function createImportDocumentBundleResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
374
+ /**
375
+ * Creates a new instance of the appropriate class based on discriminator value
376
+ * @param parseNode The parse node to use to read the discriminator value and create the object
377
+ * @returns {ParseJobAppliedResult}
378
+ */
379
+ export declare function createParseJobAppliedResultFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
380
+ /**
381
+ * Creates a new instance of the appropriate class based on discriminator value
382
+ * @param parseNode The parse node to use to read the discriminator value and create the object
383
+ * @returns {PhoneValidationDetails}
384
+ */
385
+ export declare function createPhoneValidationDetailsFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
386
+ /**
387
+ * Creates a new instance of the appropriate class based on discriminator value
388
+ * @param parseNode The parse node to use to read the discriminator value and create the object
389
+ * @returns {PhoneValidationError}
390
+ */
391
+ export declare function createPhoneValidationErrorFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
176
392
  export interface CreateQuestionBody extends AdditionalDataHolder, Parsable {
177
393
  /**
178
394
  * The context property
@@ -219,6 +435,12 @@ export type CreateQuestionBody_type = (typeof CreateQuestionBody_typeObject)[key
219
435
  * @returns {Question}
220
436
  */
221
437
  export declare function createQuestionFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
438
+ /**
439
+ * Creates a new instance of the appropriate class based on discriminator value
440
+ * @param parseNode The parse node to use to read the discriminator value and create the object
441
+ * @returns {QuotaExceededError}
442
+ */
443
+ export declare function createQuotaExceededErrorFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
222
444
  export interface CreateRecipientBody extends AdditionalDataHolder, Parsable {
223
445
  /**
224
446
  * The email property
@@ -237,11 +459,11 @@ export interface CreateRecipientBody extends AdditionalDataHolder, Parsable {
237
459
  */
238
460
  password?: string | null;
239
461
  /**
240
- * The phone property
462
+ * Accepted formatted phone input. International input may include spaces, parentheses, and hyphens, but must include `+`. National input uses the workspace default phone country.
241
463
  */
242
464
  phone?: string | null;
243
465
  /**
244
- * Map of question ID → pre-filled value. The value is saved as a Response.
466
+ * Map of question ID or exact question text → pre-filled value. The value is saved as a Response.
245
467
  */
246
468
  prefill?: CreateRecipientBody_prefill | null;
247
469
  /**
@@ -250,10 +472,22 @@ export interface CreateRecipientBody extends AdditionalDataHolder, Parsable {
250
472
  suppressNotifications?: boolean | null;
251
473
  }
252
474
  /**
253
- * Map of question ID → pre-filled value. The value is saved as a Response.
475
+ * Map of question ID or exact question text → pre-filled value. The value is saved as a Response.
254
476
  */
255
477
  export interface CreateRecipientBody_prefill extends AdditionalDataHolder, Parsable {
256
478
  }
479
+ /**
480
+ * Creates a new instance of the appropriate class based on discriminator value
481
+ * @param parseNode The parse node to use to read the discriminator value and create the object
482
+ * @returns {RecipientBulkCreateResult}
483
+ */
484
+ export declare function createRecipientBulkCreateResultFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
485
+ /**
486
+ * Creates a new instance of the appropriate class based on discriminator value
487
+ * @param parseNode The parse node to use to read the discriminator value and create the object
488
+ * @returns {RecipientCreateResult}
489
+ */
490
+ export declare function createRecipientCreateResultFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
257
491
  /**
258
492
  * Creates a new instance of the appropriate class based on discriminator value
259
493
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -266,6 +500,12 @@ export declare function createRecipientFromDiscriminatorValue(parseNode: ParseNo
266
500
  * @returns {RecipientResponse}
267
501
  */
268
502
  export declare function createRecipientResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
503
+ /**
504
+ * Creates a new instance of the appropriate class based on discriminator value
505
+ * @param parseNode The parse node to use to read the discriminator value and create the object
506
+ * @returns {RecipientUpdate}
507
+ */
508
+ export declare function createRecipientUpdateFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
269
509
  export interface CreateSectionBody extends AdditionalDataHolder, Parsable {
270
510
  /**
271
511
  * The order property
@@ -318,22 +558,122 @@ export interface CreateSignerRoleBody extends AdditionalDataHolder, Parsable {
318
558
  * @returns {SignerRole}
319
559
  */
320
560
  export declare function createSignerRoleFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
561
+ /**
562
+ * Creates a new instance of the appropriate class based on discriminator value
563
+ * @param parseNode The parse node to use to read the discriminator value and create the object
564
+ * @returns {SignerUpdate}
565
+ */
566
+ export declare function createSignerUpdateFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
567
+ /**
568
+ * Creates a new instance of the appropriate class based on discriminator value
569
+ * @param parseNode The parse node to use to read the discriminator value and create the object
570
+ * @returns {StartDocumentParseJobBody}
571
+ */
572
+ export declare function createStartDocumentParseJobBodyFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
573
+ /**
574
+ * Creates a new instance of the appropriate class based on discriminator value
575
+ * @param parseNode The parse node to use to read the discriminator value and create the object
576
+ * @returns {StartDocumentParseJobResponse_data}
577
+ */
578
+ export declare function createStartDocumentParseJobResponse_dataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
579
+ /**
580
+ * Creates a new instance of the appropriate class based on discriminator value
581
+ * @param parseNode The parse node to use to read the discriminator value and create the object
582
+ * @returns {StartDocumentParseJobResponse_meta}
583
+ */
584
+ export declare function createStartDocumentParseJobResponse_metaFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
585
+ /**
586
+ * Creates a new instance of the appropriate class based on discriminator value
587
+ * @param parseNode The parse node to use to read the discriminator value and create the object
588
+ * @returns {StartDocumentParseJobResponse}
589
+ */
590
+ export declare function createStartDocumentParseJobResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
591
+ /**
592
+ * Creates a signing submission. The normalized serialized request cannot exceed 1048576 UTF-8 bytes.
593
+ */
321
594
  export interface CreateSubmissionBody extends AdditionalDataHolder, Parsable {
322
595
  /**
323
- * One entry per signer role. Must provide all required roles.
596
+ * Signing experience used by generated links. Defaults to the document signing view.
597
+ */
598
+ deliveryFormat?: CreateSubmissionBody_deliveryFormat | null;
599
+ /**
600
+ * One entry per signer role. Must provide all required roles. Maximum 100 signers per submission.
324
601
  */
325
602
  signers?: SignerInput[] | null;
326
603
  /**
327
- * If true, suppresses signer_invite notifications for all signers in this submission.
604
+ * Suppresses signer_invite notifications for all signers in this submission. Defaults to true; set false to send notifications.
328
605
  */
329
606
  suppressNotifications?: boolean | null;
330
607
  }
608
+ export type CreateSubmissionBody_deliveryFormat = (typeof CreateSubmissionBody_deliveryFormatObject)[keyof typeof CreateSubmissionBody_deliveryFormatObject];
331
609
  /**
332
610
  * Creates a new instance of the appropriate class based on discriminator value
333
611
  * @param parseNode The parse node to use to read the discriminator value and create the object
334
612
  * @returns {SubmissionPdf}
335
613
  */
336
614
  export declare function createSubmissionPdfFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
615
+ export interface CreateSubmissionResponse extends AdditionalDataHolder, Parsable {
616
+ /**
617
+ * The data property
618
+ */
619
+ data?: CreateSubmissionResult | null;
620
+ /**
621
+ * The success property
622
+ */
623
+ success?: boolean | null;
624
+ }
625
+ export interface CreateSubmissionResult extends AdditionalDataHolder, Parsable {
626
+ /**
627
+ * Durable delivery dispatch correlated with this signing submission.
628
+ */
629
+ dispatchId?: Guid | null;
630
+ /**
631
+ * True when the Idempotency-Key matched the same normalized request and the existing submission and dispatch were returned.
632
+ */
633
+ dispatchReused?: boolean | null;
634
+ /**
635
+ * Confirms that signing links were created. Delivery continues independently through the correlated dispatch.
636
+ */
637
+ linksCreated?: boolean | null;
638
+ /**
639
+ * The signers property
640
+ */
641
+ signers?: CreateSubmissionSignerResult[] | null;
642
+ /**
643
+ * The submissionId property
644
+ */
645
+ submissionId?: Guid | null;
646
+ }
647
+ export interface CreateSubmissionSignerResult extends AdditionalDataHolder, Parsable {
648
+ /**
649
+ * The color property
650
+ */
651
+ color?: string | null;
652
+ /**
653
+ * The id property
654
+ */
655
+ id?: Guid | null;
656
+ /**
657
+ * The label property
658
+ */
659
+ label?: string | null;
660
+ /**
661
+ * Authorized live signing link. This bearer link is returned to the caller but is not stored in dispatch evidence.
662
+ */
663
+ link?: string | null;
664
+ /**
665
+ * The name property
666
+ */
667
+ name?: string | null;
668
+ /**
669
+ * The order property
670
+ */
671
+ order?: number | null;
672
+ /**
673
+ * The role property
674
+ */
675
+ role?: string | null;
676
+ }
337
677
  /**
338
678
  * Creates a new instance of the appropriate class based on discriminator value
339
679
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -364,6 +704,12 @@ export declare function createUpdateRecipientResponsesBodyFromDiscriminatorValue
364
704
  * @returns {UpdateSectionBody}
365
705
  */
366
706
  export declare function createUpdateSectionBodyFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
707
+ /**
708
+ * Creates a new instance of the appropriate class based on discriminator value
709
+ * @param parseNode The parse node to use to read the discriminator value and create the object
710
+ * @returns {UpdateSignerBody}
711
+ */
712
+ export declare function createUpdateSignerBodyFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
367
713
  /**
368
714
  * Creates a new instance of the appropriate class based on discriminator value
369
715
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -377,44 +723,80 @@ export declare function createUpdateSignerResponsesBody_responsesFromDiscriminat
377
723
  */
378
724
  export declare function createUpdateSignerResponsesBodyFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
379
725
  /**
380
- * The deserialization information for the current model
381
- * @param CreateFieldBody The instance to deserialize into.
382
- * @returns {Record<string, (node: ParseNode) => void>}
726
+ * Creates a new instance of the appropriate class based on discriminator value
727
+ * @param parseNode The parse node to use to read the discriminator value and create the object
728
+ * @returns {ValidationError}
383
729
  */
384
- export declare function deserializeIntoCreateFieldBody(createFieldBody?: Partial<CreateFieldBody> | undefined): Record<string, (node: ParseNode) => void>;
730
+ export declare function createValidationErrorFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
385
731
  /**
386
732
  * The deserialization information for the current model
387
- * @param CreateFieldBody_options The instance to deserialize into.
733
+ * @param ApplyDocumentParseJobResponse The instance to deserialize into.
388
734
  * @returns {Record<string, (node: ParseNode) => void>}
389
735
  */
390
- export declare function deserializeIntoCreateFieldBody_options(createFieldBody_options?: Partial<CreateFieldBody_options> | undefined): Record<string, (node: ParseNode) => void>;
736
+ export declare function deserializeIntoApplyDocumentParseJobResponse(applyDocumentParseJobResponse?: Partial<ApplyDocumentParseJobResponse> | undefined): Record<string, (node: ParseNode) => void>;
391
737
  /**
392
738
  * The deserialization information for the current model
393
- * @param CreateFormBody The instance to deserialize into.
739
+ * @param ApplyDocumentParseJobResponse_meta The instance to deserialize into.
394
740
  * @returns {Record<string, (node: ParseNode) => void>}
395
741
  */
396
- export declare function deserializeIntoCreateFormBody(createFormBody?: Partial<CreateFormBody> | undefined): Record<string, (node: ParseNode) => void>;
742
+ export declare function deserializeIntoApplyDocumentParseJobResponse_meta(applyDocumentParseJobResponse_meta?: Partial<ApplyDocumentParseJobResponse_meta> | undefined): Record<string, (node: ParseNode) => void>;
397
743
  /**
398
744
  * The deserialization information for the current model
399
- * @param CreateQuestionBody The instance to deserialize into.
745
+ * @param CanonicalDocumentSubmission The instance to deserialize into.
400
746
  * @returns {Record<string, (node: ParseNode) => void>}
401
747
  */
402
- export declare function deserializeIntoCreateQuestionBody(createQuestionBody?: Partial<CreateQuestionBody> | undefined): Record<string, (node: ParseNode) => void>;
748
+ export declare function deserializeIntoCanonicalDocumentSubmission(canonicalDocumentSubmission?: Partial<CanonicalDocumentSubmission> | undefined): Record<string, (node: ParseNode) => void>;
403
749
  /**
404
750
  * The deserialization information for the current model
405
- * @param CreateRecipientBody The instance to deserialize into.
751
+ * @param CanonicalRecipient The instance to deserialize into.
406
752
  * @returns {Record<string, (node: ParseNode) => void>}
407
753
  */
408
- export declare function deserializeIntoCreateRecipientBody(createRecipientBody?: Partial<CreateRecipientBody> | undefined): Record<string, (node: ParseNode) => void>;
754
+ export declare function deserializeIntoCanonicalRecipient(canonicalRecipient?: Partial<CanonicalRecipient> | undefined): Record<string, (node: ParseNode) => void>;
409
755
  /**
410
756
  * The deserialization information for the current model
411
- * @param CreateRecipientBody_prefill The instance to deserialize into.
757
+ * @param CanonicalSigner The instance to deserialize into.
412
758
  * @returns {Record<string, (node: ParseNode) => void>}
413
759
  */
414
- export declare function deserializeIntoCreateRecipientBody_prefill(createRecipientBody_prefill?: Partial<CreateRecipientBody_prefill> | undefined): Record<string, (node: ParseNode) => void>;
760
+ export declare function deserializeIntoCanonicalSigner(canonicalSigner?: Partial<CanonicalSigner> | undefined): Record<string, (node: ParseNode) => void>;
415
761
  /**
416
762
  * The deserialization information for the current model
417
- * @param CreateSectionBody The instance to deserialize into.
763
+ * @param CreateFieldBody The instance to deserialize into.
764
+ * @returns {Record<string, (node: ParseNode) => void>}
765
+ */
766
+ export declare function deserializeIntoCreateFieldBody(createFieldBody?: Partial<CreateFieldBody> | undefined): Record<string, (node: ParseNode) => void>;
767
+ /**
768
+ * The deserialization information for the current model
769
+ * @param CreateFieldBody_options The instance to deserialize into.
770
+ * @returns {Record<string, (node: ParseNode) => void>}
771
+ */
772
+ export declare function deserializeIntoCreateFieldBody_options(createFieldBody_options?: Partial<CreateFieldBody_options> | undefined): Record<string, (node: ParseNode) => void>;
773
+ /**
774
+ * The deserialization information for the current model
775
+ * @param CreateFormBody The instance to deserialize into.
776
+ * @returns {Record<string, (node: ParseNode) => void>}
777
+ */
778
+ export declare function deserializeIntoCreateFormBody(createFormBody?: Partial<CreateFormBody> | undefined): Record<string, (node: ParseNode) => void>;
779
+ /**
780
+ * The deserialization information for the current model
781
+ * @param CreateQuestionBody The instance to deserialize into.
782
+ * @returns {Record<string, (node: ParseNode) => void>}
783
+ */
784
+ export declare function deserializeIntoCreateQuestionBody(createQuestionBody?: Partial<CreateQuestionBody> | undefined): Record<string, (node: ParseNode) => void>;
785
+ /**
786
+ * The deserialization information for the current model
787
+ * @param CreateRecipientBody The instance to deserialize into.
788
+ * @returns {Record<string, (node: ParseNode) => void>}
789
+ */
790
+ export declare function deserializeIntoCreateRecipientBody(createRecipientBody?: Partial<CreateRecipientBody> | undefined): Record<string, (node: ParseNode) => void>;
791
+ /**
792
+ * The deserialization information for the current model
793
+ * @param CreateRecipientBody_prefill The instance to deserialize into.
794
+ * @returns {Record<string, (node: ParseNode) => void>}
795
+ */
796
+ export declare function deserializeIntoCreateRecipientBody_prefill(createRecipientBody_prefill?: Partial<CreateRecipientBody_prefill> | undefined): Record<string, (node: ParseNode) => void>;
797
+ /**
798
+ * The deserialization information for the current model
799
+ * @param CreateSectionBody The instance to deserialize into.
418
800
  * @returns {Record<string, (node: ParseNode) => void>}
419
801
  */
420
802
  export declare function deserializeIntoCreateSectionBody(createSectionBody?: Partial<CreateSectionBody> | undefined): Record<string, (node: ParseNode) => void>;
@@ -430,6 +812,36 @@ export declare function deserializeIntoCreateSignerRoleBody(createSignerRoleBody
430
812
  * @returns {Record<string, (node: ParseNode) => void>}
431
813
  */
432
814
  export declare function deserializeIntoCreateSubmissionBody(createSubmissionBody?: Partial<CreateSubmissionBody> | undefined): Record<string, (node: ParseNode) => void>;
815
+ /**
816
+ * The deserialization information for the current model
817
+ * @param CreateSubmissionResponse The instance to deserialize into.
818
+ * @returns {Record<string, (node: ParseNode) => void>}
819
+ */
820
+ export declare function deserializeIntoCreateSubmissionResponse(createSubmissionResponse?: Partial<CreateSubmissionResponse> | undefined): Record<string, (node: ParseNode) => void>;
821
+ /**
822
+ * The deserialization information for the current model
823
+ * @param CreateSubmissionResult The instance to deserialize into.
824
+ * @returns {Record<string, (node: ParseNode) => void>}
825
+ */
826
+ export declare function deserializeIntoCreateSubmissionResult(createSubmissionResult?: Partial<CreateSubmissionResult> | undefined): Record<string, (node: ParseNode) => void>;
827
+ /**
828
+ * The deserialization information for the current model
829
+ * @param CreateSubmissionSignerResult The instance to deserialize into.
830
+ * @returns {Record<string, (node: ParseNode) => void>}
831
+ */
832
+ export declare function deserializeIntoCreateSubmissionSignerResult(createSubmissionSignerResult?: Partial<CreateSubmissionSignerResult> | undefined): Record<string, (node: ParseNode) => void>;
833
+ /**
834
+ * The deserialization information for the current model
835
+ * @param DetectedDocumentField The instance to deserialize into.
836
+ * @returns {Record<string, (node: ParseNode) => void>}
837
+ */
838
+ export declare function deserializeIntoDetectedDocumentField(detectedDocumentField?: Partial<DetectedDocumentField> | undefined): Record<string, (node: ParseNode) => void>;
839
+ /**
840
+ * The deserialization information for the current model
841
+ * @param DetectedDocumentField_rect The instance to deserialize into.
842
+ * @returns {Record<string, (node: ParseNode) => void>}
843
+ */
844
+ export declare function deserializeIntoDetectedDocumentField_rect(detectedDocumentField_rect?: Partial<DetectedDocumentField_rect> | undefined): Record<string, (node: ParseNode) => void>;
433
845
  /**
434
846
  * The deserialization information for the current model
435
847
  * @param Document The instance to deserialize into.
@@ -454,12 +866,60 @@ export declare function deserializeIntoDocumentField(documentField?: Partial<Doc
454
866
  * @returns {Record<string, (node: ParseNode) => void>}
455
867
  */
456
868
  export declare function deserializeIntoDocumentField_options(documentField_options?: Partial<DocumentField_options> | undefined): Record<string, (node: ParseNode) => void>;
869
+ /**
870
+ * The deserialization information for the current model
871
+ * @param DocumentNotEditableConflict The instance to deserialize into.
872
+ * @returns {Record<string, (node: ParseNode) => void>}
873
+ */
874
+ export declare function deserializeIntoDocumentNotEditableConflict(documentNotEditableConflict?: Partial<DocumentNotEditableConflict> | undefined): Record<string, (node: ParseNode) => void>;
875
+ /**
876
+ * The deserialization information for the current model
877
+ * @param DocumentParseJobResult The instance to deserialize into.
878
+ * @returns {Record<string, (node: ParseNode) => void>}
879
+ */
880
+ export declare function deserializeIntoDocumentParseJobResult(documentParseJobResult?: Partial<DocumentParseJobResult> | undefined): Record<string, (node: ParseNode) => void>;
881
+ /**
882
+ * The deserialization information for the current model
883
+ * @param DocumentParseJobResult_stats The instance to deserialize into.
884
+ * @returns {Record<string, (node: ParseNode) => void>}
885
+ */
886
+ export declare function deserializeIntoDocumentParseJobResult_stats(documentParseJobResult_stats?: Partial<DocumentParseJobResult_stats> | undefined): Record<string, (node: ParseNode) => void>;
887
+ /**
888
+ * The deserialization information for the current model
889
+ * @param DocumentRevision The instance to deserialize into.
890
+ * @returns {Record<string, (node: ParseNode) => void>}
891
+ */
892
+ export declare function deserializeIntoDocumentRevision(documentRevision?: Partial<DocumentRevision> | undefined): Record<string, (node: ParseNode) => void>;
457
893
  /**
458
894
  * The deserialization information for the current model
459
895
  * @param DocumentSubmission The instance to deserialize into.
460
896
  * @returns {Record<string, (node: ParseNode) => void>}
461
897
  */
462
898
  export declare function deserializeIntoDocumentSubmission(documentSubmission?: Partial<DocumentSubmission> | undefined): Record<string, (node: ParseNode) => void>;
899
+ /**
900
+ * The deserialization information for the current model
901
+ * @param DocumentSubmission_signedPdf The instance to deserialize into.
902
+ * @returns {Record<string, (node: ParseNode) => void>}
903
+ */
904
+ export declare function deserializeIntoDocumentSubmission_signedPdf(documentSubmission_signedPdf?: Partial<DocumentSubmission_signedPdf> | undefined): Record<string, (node: ParseNode) => void>;
905
+ /**
906
+ * The deserialization information for the current model
907
+ * @param FileDescriptor The instance to deserialize into.
908
+ * @returns {Record<string, (node: ParseNode) => void>}
909
+ */
910
+ export declare function deserializeIntoFileDescriptor(fileDescriptor?: Partial<FileDescriptor> | undefined): Record<string, (node: ParseNode) => void>;
911
+ /**
912
+ * The deserialization information for the current model
913
+ * @param FileDownload The instance to deserialize into.
914
+ * @returns {Record<string, (node: ParseNode) => void>}
915
+ */
916
+ export declare function deserializeIntoFileDownload(fileDownload?: Partial<FileDownload> | undefined): Record<string, (node: ParseNode) => void>;
917
+ /**
918
+ * The deserialization information for the current model
919
+ * @param FileDownloadResponse The instance to deserialize into.
920
+ * @returns {Record<string, (node: ParseNode) => void>}
921
+ */
922
+ export declare function deserializeIntoFileDownloadResponse(fileDownloadResponse?: Partial<FileDownloadResponse> | undefined): Record<string, (node: ParseNode) => void>;
463
923
  /**
464
924
  * The deserialization information for the current model
465
925
  * @param Form The instance to deserialize into.
@@ -478,24 +938,108 @@ export declare function deserializeIntoForm_branding(form_branding?: Partial<For
478
938
  * @returns {Record<string, (node: ParseNode) => void>}
479
939
  */
480
940
  export declare function deserializeIntoForm_settings(form_settings?: Partial<Form_settings> | undefined): Record<string, (node: ParseNode) => void>;
941
+ /**
942
+ * The deserialization information for the current model
943
+ * @param FormRevision The instance to deserialize into.
944
+ * @returns {Record<string, (node: ParseNode) => void>}
945
+ */
946
+ export declare function deserializeIntoFormRevision(formRevision?: Partial<FormRevision> | undefined): Record<string, (node: ParseNode) => void>;
947
+ /**
948
+ * The deserialization information for the current model
949
+ * @param GetDocumentParseJobResponse The instance to deserialize into.
950
+ * @returns {Record<string, (node: ParseNode) => void>}
951
+ */
952
+ export declare function deserializeIntoGetDocumentParseJobResponse(getDocumentParseJobResponse?: Partial<GetDocumentParseJobResponse> | undefined): Record<string, (node: ParseNode) => void>;
953
+ /**
954
+ * The deserialization information for the current model
955
+ * @param GetDocumentParseJobResponse_data The instance to deserialize into.
956
+ * @returns {Record<string, (node: ParseNode) => void>}
957
+ */
958
+ export declare function deserializeIntoGetDocumentParseJobResponse_data(getDocumentParseJobResponse_data?: Partial<GetDocumentParseJobResponse_data> | undefined): Record<string, (node: ParseNode) => void>;
959
+ /**
960
+ * The deserialization information for the current model
961
+ * @param GetDocumentParseJobResponse_meta The instance to deserialize into.
962
+ * @returns {Record<string, (node: ParseNode) => void>}
963
+ */
964
+ export declare function deserializeIntoGetDocumentParseJobResponse_meta(getDocumentParseJobResponse_meta?: Partial<GetDocumentParseJobResponse_meta> | undefined): Record<string, (node: ParseNode) => void>;
965
+ /**
966
+ * The deserialization information for the current model
967
+ * @param ImportDocumentBundleResponse The instance to deserialize into.
968
+ * @returns {Record<string, (node: ParseNode) => void>}
969
+ */
970
+ export declare function deserializeIntoImportDocumentBundleResponse(importDocumentBundleResponse?: Partial<ImportDocumentBundleResponse> | undefined): Record<string, (node: ParseNode) => void>;
971
+ /**
972
+ * The deserialization information for the current model
973
+ * @param ImportDocumentBundleResponse_data The instance to deserialize into.
974
+ * @returns {Record<string, (node: ParseNode) => void>}
975
+ */
976
+ export declare function deserializeIntoImportDocumentBundleResponse_data(importDocumentBundleResponse_data?: Partial<ImportDocumentBundleResponse_data> | undefined): Record<string, (node: ParseNode) => void>;
977
+ /**
978
+ * The deserialization information for the current model
979
+ * @param ImportDocumentBundleResponse_meta The instance to deserialize into.
980
+ * @returns {Record<string, (node: ParseNode) => void>}
981
+ */
982
+ export declare function deserializeIntoImportDocumentBundleResponse_meta(importDocumentBundleResponse_meta?: Partial<ImportDocumentBundleResponse_meta> | undefined): Record<string, (node: ParseNode) => void>;
983
+ /**
984
+ * The deserialization information for the current model
985
+ * @param ParseJobAppliedResult The instance to deserialize into.
986
+ * @returns {Record<string, (node: ParseNode) => void>}
987
+ */
988
+ export declare function deserializeIntoParseJobAppliedResult(parseJobAppliedResult?: Partial<ParseJobAppliedResult> | undefined): Record<string, (node: ParseNode) => void>;
989
+ /**
990
+ * The deserialization information for the current model
991
+ * @param PhoneValidationDetails The instance to deserialize into.
992
+ * @returns {Record<string, (node: ParseNode) => void>}
993
+ */
994
+ export declare function deserializeIntoPhoneValidationDetails(phoneValidationDetails?: Partial<PhoneValidationDetails> | undefined): Record<string, (node: ParseNode) => void>;
995
+ /**
996
+ * The deserialization information for the current model
997
+ * @param PhoneValidationError The instance to deserialize into.
998
+ * @returns {Record<string, (node: ParseNode) => void>}
999
+ */
1000
+ export declare function deserializeIntoPhoneValidationError(phoneValidationError?: Partial<PhoneValidationError> | undefined): Record<string, (node: ParseNode) => void>;
481
1001
  /**
482
1002
  * The deserialization information for the current model
483
1003
  * @param Question The instance to deserialize into.
484
1004
  * @returns {Record<string, (node: ParseNode) => void>}
485
1005
  */
486
1006
  export declare function deserializeIntoQuestion(question?: Partial<Question> | undefined): Record<string, (node: ParseNode) => void>;
1007
+ /**
1008
+ * The deserialization information for the current model
1009
+ * @param QuotaExceededError The instance to deserialize into.
1010
+ * @returns {Record<string, (node: ParseNode) => void>}
1011
+ */
1012
+ export declare function deserializeIntoQuotaExceededError(quotaExceededError?: Partial<QuotaExceededError> | undefined): Record<string, (node: ParseNode) => void>;
487
1013
  /**
488
1014
  * The deserialization information for the current model
489
1015
  * @param Recipient The instance to deserialize into.
490
1016
  * @returns {Record<string, (node: ParseNode) => void>}
491
1017
  */
492
1018
  export declare function deserializeIntoRecipient(recipient?: Partial<Recipient> | undefined): Record<string, (node: ParseNode) => void>;
1019
+ /**
1020
+ * The deserialization information for the current model
1021
+ * @param RecipientBulkCreateResult The instance to deserialize into.
1022
+ * @returns {Record<string, (node: ParseNode) => void>}
1023
+ */
1024
+ export declare function deserializeIntoRecipientBulkCreateResult(recipientBulkCreateResult?: Partial<RecipientBulkCreateResult> | undefined): Record<string, (node: ParseNode) => void>;
1025
+ /**
1026
+ * The deserialization information for the current model
1027
+ * @param RecipientCreateResult The instance to deserialize into.
1028
+ * @returns {Record<string, (node: ParseNode) => void>}
1029
+ */
1030
+ export declare function deserializeIntoRecipientCreateResult(recipientCreateResult?: Partial<RecipientCreateResult> | undefined): Record<string, (node: ParseNode) => void>;
493
1031
  /**
494
1032
  * The deserialization information for the current model
495
1033
  * @param RecipientResponse The instance to deserialize into.
496
1034
  * @returns {Record<string, (node: ParseNode) => void>}
497
1035
  */
498
1036
  export declare function deserializeIntoRecipientResponse(recipientResponse?: Partial<RecipientResponse> | undefined): Record<string, (node: ParseNode) => void>;
1037
+ /**
1038
+ * The deserialization information for the current model
1039
+ * @param RecipientUpdate The instance to deserialize into.
1040
+ * @returns {Record<string, (node: ParseNode) => void>}
1041
+ */
1042
+ export declare function deserializeIntoRecipientUpdate(recipientUpdate?: Partial<RecipientUpdate> | undefined): Record<string, (node: ParseNode) => void>;
499
1043
  /**
500
1044
  * The deserialization information for the current model
501
1045
  * @param Section The instance to deserialize into.
@@ -532,6 +1076,36 @@ export declare function deserializeIntoSignerResponse(signerResponse?: Partial<S
532
1076
  * @returns {Record<string, (node: ParseNode) => void>}
533
1077
  */
534
1078
  export declare function deserializeIntoSignerRole(signerRole?: Partial<SignerRole> | undefined): Record<string, (node: ParseNode) => void>;
1079
+ /**
1080
+ * The deserialization information for the current model
1081
+ * @param SignerUpdate The instance to deserialize into.
1082
+ * @returns {Record<string, (node: ParseNode) => void>}
1083
+ */
1084
+ export declare function deserializeIntoSignerUpdate(signerUpdate?: Partial<SignerUpdate> | undefined): Record<string, (node: ParseNode) => void>;
1085
+ /**
1086
+ * The deserialization information for the current model
1087
+ * @param StartDocumentParseJobBody The instance to deserialize into.
1088
+ * @returns {Record<string, (node: ParseNode) => void>}
1089
+ */
1090
+ export declare function deserializeIntoStartDocumentParseJobBody(startDocumentParseJobBody?: Partial<StartDocumentParseJobBody> | undefined): Record<string, (node: ParseNode) => void>;
1091
+ /**
1092
+ * The deserialization information for the current model
1093
+ * @param StartDocumentParseJobResponse The instance to deserialize into.
1094
+ * @returns {Record<string, (node: ParseNode) => void>}
1095
+ */
1096
+ export declare function deserializeIntoStartDocumentParseJobResponse(startDocumentParseJobResponse?: Partial<StartDocumentParseJobResponse> | undefined): Record<string, (node: ParseNode) => void>;
1097
+ /**
1098
+ * The deserialization information for the current model
1099
+ * @param StartDocumentParseJobResponse_data The instance to deserialize into.
1100
+ * @returns {Record<string, (node: ParseNode) => void>}
1101
+ */
1102
+ export declare function deserializeIntoStartDocumentParseJobResponse_data(startDocumentParseJobResponse_data?: Partial<StartDocumentParseJobResponse_data> | undefined): Record<string, (node: ParseNode) => void>;
1103
+ /**
1104
+ * The deserialization information for the current model
1105
+ * @param StartDocumentParseJobResponse_meta The instance to deserialize into.
1106
+ * @returns {Record<string, (node: ParseNode) => void>}
1107
+ */
1108
+ export declare function deserializeIntoStartDocumentParseJobResponse_meta(startDocumentParseJobResponse_meta?: Partial<StartDocumentParseJobResponse_meta> | undefined): Record<string, (node: ParseNode) => void>;
535
1109
  /**
536
1110
  * The deserialization information for the current model
537
1111
  * @param SubmissionPdf The instance to deserialize into.
@@ -568,6 +1142,12 @@ export declare function deserializeIntoUpdateRecipientResponsesBody_responses(up
568
1142
  * @returns {Record<string, (node: ParseNode) => void>}
569
1143
  */
570
1144
  export declare function deserializeIntoUpdateSectionBody(updateSectionBody?: Partial<UpdateSectionBody> | undefined): Record<string, (node: ParseNode) => void>;
1145
+ /**
1146
+ * The deserialization information for the current model
1147
+ * @param UpdateSignerBody The instance to deserialize into.
1148
+ * @returns {Record<string, (node: ParseNode) => void>}
1149
+ */
1150
+ export declare function deserializeIntoUpdateSignerBody(updateSignerBody?: Partial<UpdateSignerBody> | undefined): Record<string, (node: ParseNode) => void>;
571
1151
  /**
572
1152
  * The deserialization information for the current model
573
1153
  * @param UpdateSignerResponsesBody The instance to deserialize into.
@@ -580,6 +1160,53 @@ export declare function deserializeIntoUpdateSignerResponsesBody(updateSignerRes
580
1160
  * @returns {Record<string, (node: ParseNode) => void>}
581
1161
  */
582
1162
  export declare function deserializeIntoUpdateSignerResponsesBody_responses(updateSignerResponsesBody_responses?: Partial<UpdateSignerResponsesBody_responses> | undefined): Record<string, (node: ParseNode) => void>;
1163
+ /**
1164
+ * The deserialization information for the current model
1165
+ * @param ValidationError The instance to deserialize into.
1166
+ * @returns {Record<string, (node: ParseNode) => void>}
1167
+ */
1168
+ export declare function deserializeIntoValidationError(validationError?: Partial<ValidationError> | undefined): Record<string, (node: ParseNode) => void>;
1169
+ export interface DetectedDocumentField extends AdditionalDataHolder, Parsable {
1170
+ /**
1171
+ * The confidence property
1172
+ */
1173
+ confidence?: number | null;
1174
+ /**
1175
+ * The label property
1176
+ */
1177
+ label?: string | null;
1178
+ /**
1179
+ * The pageNumber property
1180
+ */
1181
+ pageNumber?: number | null;
1182
+ /**
1183
+ * The rect property
1184
+ */
1185
+ rect?: DetectedDocumentField_rect | null;
1186
+ /**
1187
+ * The type property
1188
+ */
1189
+ type?: DetectedDocumentField_type | null;
1190
+ }
1191
+ export interface DetectedDocumentField_rect extends AdditionalDataHolder, Parsable {
1192
+ /**
1193
+ * The height property
1194
+ */
1195
+ height?: number | null;
1196
+ /**
1197
+ * The width property
1198
+ */
1199
+ width?: number | null;
1200
+ /**
1201
+ * The x property
1202
+ */
1203
+ x?: number | null;
1204
+ /**
1205
+ * The y property
1206
+ */
1207
+ y?: number | null;
1208
+ }
1209
+ export type DetectedDocumentField_type = (typeof DetectedDocumentField_typeObject)[keyof typeof DetectedDocumentField_typeObject];
583
1210
  export interface Document extends AdditionalDataHolder, Parsable {
584
1211
  /**
585
1212
  * The completedPdfUrl property
@@ -691,7 +1318,7 @@ export interface DocumentField extends AdditionalDataHolder, Parsable {
691
1318
  */
692
1319
  label?: string | null;
693
1320
  /**
694
- * The options property
1321
+ * Type-specific options. A file_upload field with supporting_attachment: true is a supporting attachment request with zero geometry, excluded from the rendered document and signed PDF.
695
1322
  */
696
1323
  options?: DocumentField_options | null;
697
1324
  /**
@@ -699,7 +1326,7 @@ export interface DocumentField extends AdditionalDataHolder, Parsable {
699
1326
  */
700
1327
  order?: number | null;
701
1328
  /**
702
- * The pageNumber property
1329
+ * PDF page number, starting at 1. Zero means no PDF-page placement, as used by generated block fields and supporting attachment requests.
703
1330
  */
704
1331
  pageNumber?: number | null;
705
1332
  /**
@@ -720,22 +1347,56 @@ export interface DocumentField extends AdditionalDataHolder, Parsable {
720
1347
  y?: number | null;
721
1348
  }
722
1349
  export type DocumentField_direction = (typeof DocumentField_directionObject)[keyof typeof DocumentField_directionObject];
1350
+ /**
1351
+ * Type-specific options. A file_upload field with supporting_attachment: true is a supporting attachment request with zero geometry, excluded from the rendered document and signed PDF.
1352
+ */
723
1353
  export interface DocumentField_options extends AdditionalDataHolder, Parsable {
1354
+ /**
1355
+ * Set true for a supporting upload request excluded from the document and signed PDF. Only file_upload supports this flag; false and changing the field purpose after creation are rejected.
1356
+ */
1357
+ supportingAttachment?: boolean | null;
724
1358
  }
725
1359
  export type DocumentField_type = (typeof DocumentField_typeObject)[keyof typeof DocumentField_typeObject];
726
- export interface DocumentSubmission extends AdditionalDataHolder, Parsable {
1360
+ export interface DocumentNotEditableConflict extends AdditionalDataHolder, ApiError, Parsable {
727
1361
  /**
728
- * The completedAt property
1362
+ * The code property
729
1363
  */
730
- completedAt?: Date | null;
1364
+ code?: DocumentNotEditableConflict_code | null;
731
1365
  /**
732
- * The completedPdfUrl property
1366
+ * The error property
733
1367
  */
734
- completedPdfUrl?: string | null;
1368
+ errorEscaped?: string | null;
735
1369
  /**
736
- * The createdAt property
1370
+ * The success property
737
1371
  */
738
- createdAt?: Date | null;
1372
+ success?: boolean | null;
1373
+ }
1374
+ export type DocumentNotEditableConflict_code = (typeof DocumentNotEditableConflict_codeObject)[keyof typeof DocumentNotEditableConflict_codeObject];
1375
+ export interface DocumentParseJobResult extends AdditionalDataHolder, Parsable {
1376
+ /**
1377
+ * The applied property
1378
+ */
1379
+ applied?: ParseJobAppliedResult | null;
1380
+ /**
1381
+ * The detectedLanguage property
1382
+ */
1383
+ detectedLanguage?: string | null;
1384
+ /**
1385
+ * The fields property
1386
+ */
1387
+ fields?: DetectedDocumentField[] | null;
1388
+ /**
1389
+ * The stats property
1390
+ */
1391
+ stats?: DocumentParseJobResult_stats | null;
1392
+ }
1393
+ export interface DocumentParseJobResult_stats extends AdditionalDataHolder, Parsable {
1394
+ }
1395
+ export interface DocumentRevision extends AdditionalDataHolder, Parsable {
1396
+ /**
1397
+ * The changesSummary property
1398
+ */
1399
+ changesSummary?: string | null;
739
1400
  /**
740
1401
  * The documentId property
741
1402
  */
@@ -745,44 +1406,197 @@ export interface DocumentSubmission extends AdditionalDataHolder, Parsable {
745
1406
  */
746
1407
  id?: Guid | null;
747
1408
  /**
748
- * The signers property
1409
+ * The publishedAt property
749
1410
  */
750
- signers?: Signer[] | null;
1411
+ publishedAt?: Date | null;
751
1412
  /**
752
- * The status property
1413
+ * The publishedBy property
753
1414
  */
754
- status?: DocumentSubmission_status | null;
1415
+ publishedBy?: string | null;
1416
+ /**
1417
+ * The snapshot property
1418
+ */
1419
+ snapshot?: UntypedNode | null;
1420
+ /**
1421
+ * The version property
1422
+ */
1423
+ version?: number | null;
755
1424
  }
756
- export type DocumentSubmission_status = (typeof DocumentSubmission_statusObject)[keyof typeof DocumentSubmission_statusObject];
757
- export interface Form extends AdditionalDataHolder, Parsable {
1425
+ export interface DocumentSubmission extends AdditionalDataHolder, Parsable {
758
1426
  /**
759
- * The branding property
1427
+ * The completedAt property
760
1428
  */
761
- branding?: Form_branding | null;
1429
+ completedAt?: Date | null;
1430
+ /**
1431
+ * Deprecated compatibility alias. For completed submissions this points to Formalingo's API-key-gated signed PDF descriptor endpoint, not raw storage. Prefer signedPdf.downloadUrl.
1432
+ */
1433
+ completedPdfUrl?: string | null;
762
1434
  /**
763
1435
  * The createdAt property
764
1436
  */
765
1437
  createdAt?: Date | null;
766
1438
  /**
767
- * The creatorId property
1439
+ * The documentId property
768
1440
  */
769
- creatorId?: Guid | null;
1441
+ documentId?: Guid | null;
770
1442
  /**
771
- * The description property
1443
+ * Immutable document revision pinned to this submission.
772
1444
  */
773
- description?: string | null;
1445
+ documentRevisionId?: Guid | null;
774
1446
  /**
775
1447
  * The id property
776
1448
  */
777
1449
  id?: Guid | null;
778
1450
  /**
779
- * The publicToken property
1451
+ * Stable API-key-gated file descriptor for the completed signed PDF.
1452
+ */
1453
+ signedPdf?: DocumentSubmission_signedPdf | null;
1454
+ /**
1455
+ * The signers property
1456
+ */
1457
+ signers?: Signer[] | null;
1458
+ /**
1459
+ * The status property
1460
+ */
1461
+ status?: DocumentSubmission_status | null;
1462
+ }
1463
+ /**
1464
+ * Stable API-key-gated file descriptor for the completed signed PDF.
1465
+ */
1466
+ export interface DocumentSubmission_signedPdf extends AdditionalDataHolder, Parsable {
1467
+ /**
1468
+ * The authorization property
1469
+ */
1470
+ authorization?: DocumentSubmission_signedPdf_authorization | null;
1471
+ /**
1472
+ * The contentType property
1473
+ */
1474
+ contentType?: string | null;
1475
+ /**
1476
+ * The downloadMethod property
1477
+ */
1478
+ downloadMethod?: DocumentSubmission_signedPdf_downloadMethod | null;
1479
+ /**
1480
+ * Formalingo API endpoint requiring Authorization: Bearer <api-key>. Request it to receive JSON with a temporary storage URL, then fetch that URL for the bytes. Response uploads, including supporting files, require submissions:download_files; signed PDFs require submissions:download_pdf.
1481
+ */
1482
+ downloadUrl?: string | null;
1483
+ /**
1484
+ * The fileId property
1485
+ */
1486
+ fileId?: Guid | null;
1487
+ /**
1488
+ * The name property
1489
+ */
1490
+ name?: string | null;
1491
+ /**
1492
+ * The sizeBytes property
1493
+ */
1494
+ sizeBytes?: number | null;
1495
+ }
1496
+ export type DocumentSubmission_signedPdf_authorization = (typeof DocumentSubmission_signedPdf_authorizationObject)[keyof typeof DocumentSubmission_signedPdf_authorizationObject];
1497
+ export type DocumentSubmission_signedPdf_downloadMethod = (typeof DocumentSubmission_signedPdf_downloadMethodObject)[keyof typeof DocumentSubmission_signedPdf_downloadMethodObject];
1498
+ export type DocumentSubmission_status = (typeof DocumentSubmission_statusObject)[keyof typeof DocumentSubmission_statusObject];
1499
+ export interface FileDescriptor extends AdditionalDataHolder, Parsable {
1500
+ /**
1501
+ * The authorization property
1502
+ */
1503
+ authorization?: FileDescriptor_authorization | null;
1504
+ /**
1505
+ * The contentType property
1506
+ */
1507
+ contentType?: string | null;
1508
+ /**
1509
+ * The downloadMethod property
1510
+ */
1511
+ downloadMethod?: FileDescriptor_downloadMethod | null;
1512
+ /**
1513
+ * Formalingo API endpoint requiring Authorization: Bearer <api-key>. Request it to receive JSON with a temporary storage URL, then fetch that URL for the bytes. Response uploads, including supporting files, require submissions:download_files; signed PDFs require submissions:download_pdf.
1514
+ */
1515
+ downloadUrl?: string | null;
1516
+ /**
1517
+ * The fileId property
1518
+ */
1519
+ fileId?: Guid | null;
1520
+ /**
1521
+ * The name property
1522
+ */
1523
+ name?: string | null;
1524
+ /**
1525
+ * The sizeBytes property
1526
+ */
1527
+ sizeBytes?: number | null;
1528
+ }
1529
+ export type FileDescriptor_authorization = (typeof FileDescriptor_authorizationObject)[keyof typeof FileDescriptor_authorizationObject];
1530
+ export type FileDescriptor_downloadMethod = (typeof FileDescriptor_downloadMethodObject)[keyof typeof FileDescriptor_downloadMethodObject];
1531
+ export interface FileDownload extends AdditionalDataHolder, Parsable {
1532
+ /**
1533
+ * The contentType property
1534
+ */
1535
+ contentType?: string | null;
1536
+ /**
1537
+ * Temporary Supabase signed URL
1538
+ */
1539
+ downloadUrl?: string | null;
1540
+ /**
1541
+ * The expiresIn property
1542
+ */
1543
+ expiresIn?: number | null;
1544
+ /**
1545
+ * The fileId property
1546
+ */
1547
+ fileId?: Guid | null;
1548
+ /**
1549
+ * The name property
1550
+ */
1551
+ name?: string | null;
1552
+ /**
1553
+ * The sizeBytes property
1554
+ */
1555
+ sizeBytes?: number | null;
1556
+ }
1557
+ export interface FileDownloadResponse extends AdditionalDataHolder, Parsable {
1558
+ /**
1559
+ * The data property
1560
+ */
1561
+ data?: FileDownload | null;
1562
+ /**
1563
+ * The success property
1564
+ */
1565
+ success?: boolean | null;
1566
+ }
1567
+ export interface Form extends AdditionalDataHolder, Parsable {
1568
+ /**
1569
+ * The branding property
1570
+ */
1571
+ branding?: Form_branding | null;
1572
+ /**
1573
+ * The createdAt property
1574
+ */
1575
+ createdAt?: Date | null;
1576
+ /**
1577
+ * The creatorId property
1578
+ */
1579
+ creatorId?: Guid | null;
1580
+ /**
1581
+ * The description property
1582
+ */
1583
+ description?: string | null;
1584
+ /**
1585
+ * The id property
1586
+ */
1587
+ id?: Guid | null;
1588
+ /**
1589
+ * The publicToken property
780
1590
  */
781
1591
  publicToken?: string | null;
782
1592
  /**
783
1593
  * The question_count property
784
1594
  */
785
1595
  questionCount?: number | null;
1596
+ /**
1597
+ * Total recipients (links/invites) for the form
1598
+ */
1599
+ sentCount?: number | null;
786
1600
  /**
787
1601
  * The settings property
788
1602
  */
@@ -792,82 +1606,541 @@ export interface Form extends AdditionalDataHolder, Parsable {
792
1606
  */
793
1607
  status?: Form_status | null;
794
1608
  /**
795
- * The title property
1609
+ * Recipients who have completed the form
1610
+ */
1611
+ submissionCount?: number | null;
1612
+ /**
1613
+ * The title property
1614
+ */
1615
+ title?: string | null;
1616
+ /**
1617
+ * The updatedAt property
1618
+ */
1619
+ updatedAt?: Date | null;
1620
+ /**
1621
+ * The workspaceId property
1622
+ */
1623
+ workspaceId?: Guid | null;
1624
+ }
1625
+ export interface Form_branding extends AdditionalDataHolder, Parsable {
1626
+ }
1627
+ export interface Form_settings extends AdditionalDataHolder, Parsable {
1628
+ }
1629
+ export type Form_status = (typeof Form_statusObject)[keyof typeof Form_statusObject];
1630
+ export interface FormRevision extends AdditionalDataHolder, Parsable {
1631
+ /**
1632
+ * The changesSummary property
1633
+ */
1634
+ changesSummary?: string | null;
1635
+ /**
1636
+ * The formId property
1637
+ */
1638
+ formId?: Guid | null;
1639
+ /**
1640
+ * The id property
1641
+ */
1642
+ id?: Guid | null;
1643
+ /**
1644
+ * The publishedAt property
1645
+ */
1646
+ publishedAt?: Date | null;
1647
+ /**
1648
+ * The publishedBy property
1649
+ */
1650
+ publishedBy?: string | null;
1651
+ /**
1652
+ * The snapshot property
1653
+ */
1654
+ snapshot?: UntypedNode | null;
1655
+ /**
1656
+ * The version property
1657
+ */
1658
+ version?: number | null;
1659
+ }
1660
+ export interface GetDocumentParseJobResponse extends AdditionalDataHolder, Parsable {
1661
+ /**
1662
+ * The data property
1663
+ */
1664
+ data?: GetDocumentParseJobResponse_data | null;
1665
+ /**
1666
+ * The meta property
1667
+ */
1668
+ meta?: GetDocumentParseJobResponse_meta | null;
1669
+ /**
1670
+ * The success property
1671
+ */
1672
+ success?: boolean | null;
1673
+ }
1674
+ export interface GetDocumentParseJobResponse_data extends AdditionalDataHolder, Parsable {
1675
+ /**
1676
+ * The applyMode property
1677
+ */
1678
+ applyMode?: GetDocumentParseJobResponse_data_applyMode | null;
1679
+ /**
1680
+ * The documentId property
1681
+ */
1682
+ documentId?: Guid | null;
1683
+ /**
1684
+ * The error property
1685
+ */
1686
+ errorEscaped?: string | null;
1687
+ /**
1688
+ * The parseJobId property
1689
+ */
1690
+ parseJobId?: Guid | null;
1691
+ /**
1692
+ * The pollAfterMs property
1693
+ */
1694
+ pollAfterMs?: number | null;
1695
+ /**
1696
+ * The result property
1697
+ */
1698
+ result?: DocumentParseJobResult | null;
1699
+ /**
1700
+ * The status property
1701
+ */
1702
+ status?: GetDocumentParseJobResponse_data_status | null;
1703
+ /**
1704
+ * The warnings property
1705
+ */
1706
+ warnings?: UntypedNode | null;
1707
+ }
1708
+ export type GetDocumentParseJobResponse_data_applyMode = (typeof GetDocumentParseJobResponse_data_applyModeObject)[keyof typeof GetDocumentParseJobResponse_data_applyModeObject];
1709
+ export type GetDocumentParseJobResponse_data_status = (typeof GetDocumentParseJobResponse_data_statusObject)[keyof typeof GetDocumentParseJobResponse_data_statusObject];
1710
+ export interface GetDocumentParseJobResponse_meta extends AdditionalDataHolder, Parsable {
1711
+ /**
1712
+ * The limit property
1713
+ */
1714
+ limit?: number | null;
1715
+ /**
1716
+ * The page property
1717
+ */
1718
+ page?: number | null;
1719
+ /**
1720
+ * Total number of records
1721
+ */
1722
+ total?: number | null;
1723
+ }
1724
+ export interface ImportDocumentBundleResponse extends AdditionalDataHolder, Parsable {
1725
+ /**
1726
+ * The actions_omitted property
1727
+ */
1728
+ actionsOmitted?: number | null;
1729
+ /**
1730
+ * The conditions_omitted property
1731
+ */
1732
+ conditionsOmitted?: number | null;
1733
+ /**
1734
+ * The data property
1735
+ */
1736
+ data?: ImportDocumentBundleResponse_data | null;
1737
+ /**
1738
+ * The meta property
1739
+ */
1740
+ meta?: ImportDocumentBundleResponse_meta | null;
1741
+ /**
1742
+ * The success property
1743
+ */
1744
+ success?: boolean | null;
1745
+ /**
1746
+ * The warnings property
1747
+ */
1748
+ warnings?: string[] | null;
1749
+ }
1750
+ export interface ImportDocumentBundleResponse_data extends AdditionalDataHolder, Parsable {
1751
+ /**
1752
+ * The generationType property
1753
+ */
1754
+ generationType?: ImportDocumentBundleResponse_data_generationType | null;
1755
+ /**
1756
+ * The id property
1757
+ */
1758
+ id?: Guid | null;
1759
+ /**
1760
+ * The originalFilename property
1761
+ */
1762
+ originalFilename?: string | null;
1763
+ /**
1764
+ * The originalUrl property
1765
+ */
1766
+ originalUrl?: string | null;
1767
+ /**
1768
+ * The status property
1769
+ */
1770
+ status?: ImportDocumentBundleResponse_data_status | null;
1771
+ /**
1772
+ * The title property
1773
+ */
1774
+ title?: string | null;
1775
+ }
1776
+ export type ImportDocumentBundleResponse_data_generationType = (typeof ImportDocumentBundleResponse_data_generationTypeObject)[keyof typeof ImportDocumentBundleResponse_data_generationTypeObject];
1777
+ export type ImportDocumentBundleResponse_data_status = (typeof ImportDocumentBundleResponse_data_statusObject)[keyof typeof ImportDocumentBundleResponse_data_statusObject];
1778
+ export interface ImportDocumentBundleResponse_meta extends AdditionalDataHolder, Parsable {
1779
+ /**
1780
+ * The limit property
1781
+ */
1782
+ limit?: number | null;
1783
+ /**
1784
+ * The page property
1785
+ */
1786
+ page?: number | null;
1787
+ /**
1788
+ * Total number of records
1789
+ */
1790
+ total?: number | null;
1791
+ }
1792
+ export interface ParseJobAppliedResult extends AdditionalDataHolder, Parsable {
1793
+ /**
1794
+ * The createdFieldIds property
1795
+ */
1796
+ createdFieldIds?: Guid[] | null;
1797
+ /**
1798
+ * The createdSignerRoleIds property
1799
+ */
1800
+ createdSignerRoleIds?: Guid[] | null;
1801
+ }
1802
+ export interface PhoneValidationDetails extends AdditionalDataHolder, Parsable {
1803
+ /**
1804
+ * Stable phone-normalization failure code.
1805
+ */
1806
+ code?: PhoneValidationDetails_code | null;
1807
+ /**
1808
+ * The invalid phone field. Indexed signer paths identify the failing signer.
1809
+ */
1810
+ field?: string | null;
1811
+ /**
1812
+ * Zero-based signer index when a submission signer phone is invalid.
1813
+ */
1814
+ index?: number | null;
1815
+ /**
1816
+ * One-based import or bulk-recipient position when a phone is invalid.
1817
+ */
1818
+ row?: number | null;
1819
+ }
1820
+ export type PhoneValidationDetails_code = (typeof PhoneValidationDetails_codeObject)[keyof typeof PhoneValidationDetails_codeObject];
1821
+ export interface PhoneValidationError extends Parsable, ValidationError {
1822
+ }
1823
+ export interface Question extends AdditionalDataHolder, Parsable {
1824
+ /**
1825
+ * The context property
1826
+ */
1827
+ context?: string | null;
1828
+ /**
1829
+ * The createdAt property
1830
+ */
1831
+ createdAt?: Date | null;
1832
+ /**
1833
+ * The formId property
1834
+ */
1835
+ formId?: Guid | null;
1836
+ /**
1837
+ * The id property
1838
+ */
1839
+ id?: Guid | null;
1840
+ /**
1841
+ * The isPii property
1842
+ */
1843
+ isPii?: boolean | null;
1844
+ /**
1845
+ * The isRequired property
1846
+ */
1847
+ isRequired?: boolean | null;
1848
+ /**
1849
+ * The options property
1850
+ */
1851
+ options?: UntypedNode | null;
1852
+ /**
1853
+ * The order property
1854
+ */
1855
+ order?: number | null;
1856
+ /**
1857
+ * The priority property
1858
+ */
1859
+ priority?: Question_priority | null;
1860
+ /**
1861
+ * The questionText property
1862
+ */
1863
+ questionText?: string | null;
1864
+ /**
1865
+ * The sectionId property
1866
+ */
1867
+ sectionId?: Guid | null;
1868
+ /**
1869
+ * The type property
1870
+ */
1871
+ type?: Question_type | null;
1872
+ }
1873
+ export type Question_priority = (typeof Question_priorityObject)[keyof typeof Question_priorityObject];
1874
+ export type Question_type = (typeof Question_typeObject)[keyof typeof Question_typeObject];
1875
+ export interface QuotaExceededError extends AdditionalDataHolder, ApiError, Parsable {
1876
+ /**
1877
+ * The requested operation would exceed a workspace plan limit.
1878
+ */
1879
+ code?: QuotaExceededError_code | null;
1880
+ /**
1881
+ * The error property
1882
+ */
1883
+ errorEscaped?: string | null;
1884
+ /**
1885
+ * The hint property
1886
+ */
1887
+ hint?: string | null;
1888
+ /**
1889
+ * The success property
1890
+ */
1891
+ success?: boolean | null;
1892
+ }
1893
+ export type QuotaExceededError_code = (typeof QuotaExceededError_codeObject)[keyof typeof QuotaExceededError_codeObject];
1894
+ export interface Recipient extends AdditionalDataHolder, Parsable {
1895
+ /**
1896
+ * The created_at property
1897
+ */
1898
+ createdAt?: Date | null;
1899
+ /**
1900
+ * The email property
1901
+ */
1902
+ email?: string | null;
1903
+ /**
1904
+ * The expires_at property
1905
+ */
1906
+ expiresAt?: Date | null;
1907
+ /**
1908
+ * The form_id property
1909
+ */
1910
+ formId?: Guid | null;
1911
+ /**
1912
+ * The has_password property
1913
+ */
1914
+ hasPassword?: boolean | null;
1915
+ /**
1916
+ * The id property
1917
+ */
1918
+ id?: Guid | null;
1919
+ /**
1920
+ * The is_active property
1921
+ */
1922
+ isActive?: boolean | null;
1923
+ /**
1924
+ * The is_anonymous property
1925
+ */
1926
+ isAnonymous?: boolean | null;
1927
+ /**
1928
+ * The label property
1929
+ */
1930
+ label?: string | null;
1931
+ /**
1932
+ * The last_activity_at property
1933
+ */
1934
+ lastActivityAt?: Date | null;
1935
+ /**
1936
+ * The link property
1937
+ */
1938
+ link?: string | null;
1939
+ /**
1940
+ * Stored phone value. Legacy list/get records can retain their pre-normalization stored value until corrected.
1941
+ */
1942
+ phone?: string | null;
1943
+ /**
1944
+ * The response_count property
1945
+ */
1946
+ responseCount?: number | null;
1947
+ /**
1948
+ * The status property
1949
+ */
1950
+ status?: Recipient_status | null;
1951
+ /**
1952
+ * The token property
1953
+ */
1954
+ token?: string | null;
1955
+ /**
1956
+ * The total_questions property
1957
+ */
1958
+ totalQuestions?: number | null;
1959
+ /**
1960
+ * The visit_count property
1961
+ */
1962
+ visitCount?: number | null;
1963
+ }
1964
+ export type Recipient_status = (typeof Recipient_statusObject)[keyof typeof Recipient_statusObject];
1965
+ export interface RecipientBulkCreateResult extends AdditionalDataHolder, Parsable {
1966
+ /**
1967
+ * The created_at property
1968
+ */
1969
+ createdAt?: Date | null;
1970
+ /**
1971
+ * Durable delivery dispatch for this recipient invitation. Null when notification delivery was suppressed or the recipient has no delivery address.
1972
+ */
1973
+ dispatchId?: Guid | null;
1974
+ /**
1975
+ * The email property
1976
+ */
1977
+ email?: string | null;
1978
+ /**
1979
+ * The expires_at property
1980
+ */
1981
+ expiresAt?: Date | null;
1982
+ /**
1983
+ * The form_id property
1984
+ */
1985
+ formId?: Guid | null;
1986
+ /**
1987
+ * The has_password property
1988
+ */
1989
+ hasPassword?: boolean | null;
1990
+ /**
1991
+ * The id property
1992
+ */
1993
+ id?: Guid | null;
1994
+ /**
1995
+ * The is_active property
1996
+ */
1997
+ isActive?: boolean | null;
1998
+ /**
1999
+ * The is_anonymous property
2000
+ */
2001
+ isAnonymous?: boolean | null;
2002
+ /**
2003
+ * The label property
2004
+ */
2005
+ label?: string | null;
2006
+ /**
2007
+ * The last_activity_at property
2008
+ */
2009
+ lastActivityAt?: Date | null;
2010
+ /**
2011
+ * The link property
2012
+ */
2013
+ link?: string | null;
2014
+ /**
2015
+ * Canonical E.164 phone value returned after a successful create or phone edit.
2016
+ */
2017
+ phone?: string | null;
2018
+ /**
2019
+ * The response_count property
2020
+ */
2021
+ responseCount?: number | null;
2022
+ /**
2023
+ * The status property
2024
+ */
2025
+ status?: RecipientBulkCreateResult_status | null;
2026
+ /**
2027
+ * The token property
2028
+ */
2029
+ token?: string | null;
2030
+ /**
2031
+ * The total_questions property
2032
+ */
2033
+ totalQuestions?: number | null;
2034
+ /**
2035
+ * The visit_count property
2036
+ */
2037
+ visitCount?: number | null;
2038
+ }
2039
+ export type RecipientBulkCreateResult_status = (typeof RecipientBulkCreateResult_statusObject)[keyof typeof RecipientBulkCreateResult_statusObject];
2040
+ export interface RecipientCreateResult extends AdditionalDataHolder, Parsable {
2041
+ /**
2042
+ * The created_at property
2043
+ */
2044
+ createdAt?: Date | null;
2045
+ /**
2046
+ * Durable delivery dispatch for this recipient invitation. Null when notification delivery was suppressed or the recipient has no delivery address.
2047
+ */
2048
+ dispatchId?: Guid | null;
2049
+ /**
2050
+ * The email property
2051
+ */
2052
+ email?: string | null;
2053
+ /**
2054
+ * The expires_at property
2055
+ */
2056
+ expiresAt?: Date | null;
2057
+ /**
2058
+ * The form_id property
2059
+ */
2060
+ formId?: Guid | null;
2061
+ /**
2062
+ * The has_password property
2063
+ */
2064
+ hasPassword?: boolean | null;
2065
+ /**
2066
+ * The id property
2067
+ */
2068
+ id?: Guid | null;
2069
+ /**
2070
+ * The is_active property
2071
+ */
2072
+ isActive?: boolean | null;
2073
+ /**
2074
+ * The is_anonymous property
796
2075
  */
797
- title?: string | null;
2076
+ isAnonymous?: boolean | null;
798
2077
  /**
799
- * The updatedAt property
2078
+ * The label property
800
2079
  */
801
- updatedAt?: Date | null;
2080
+ label?: string | null;
802
2081
  /**
803
- * The workspaceId property
2082
+ * The last_activity_at property
804
2083
  */
805
- workspaceId?: Guid | null;
806
- }
807
- export interface Form_branding extends AdditionalDataHolder, Parsable {
808
- }
809
- export interface Form_settings extends AdditionalDataHolder, Parsable {
810
- }
811
- export type Form_status = (typeof Form_statusObject)[keyof typeof Form_statusObject];
812
- export interface Question extends AdditionalDataHolder, Parsable {
2084
+ lastActivityAt?: Date | null;
813
2085
  /**
814
- * The context property
2086
+ * The link property
815
2087
  */
816
- context?: string | null;
2088
+ link?: string | null;
817
2089
  /**
818
- * The createdAt property
2090
+ * Canonical E.164 phone value returned after a successful create or phone edit.
819
2091
  */
820
- createdAt?: Date | null;
2092
+ phone?: string | null;
821
2093
  /**
822
- * The formId property
2094
+ * A one-time plaintext recipient password returned only when a password was supplied at creation. It cannot be retrieved later.
823
2095
  */
824
- formId?: Guid | null;
2096
+ plainPassword?: string | null;
825
2097
  /**
826
- * The id property
2098
+ * The response_count property
827
2099
  */
828
- id?: Guid | null;
2100
+ responseCount?: number | null;
829
2101
  /**
830
- * The isPii property
2102
+ * The status property
831
2103
  */
832
- isPii?: boolean | null;
2104
+ status?: RecipientCreateResult_status | null;
833
2105
  /**
834
- * The isRequired property
2106
+ * The token property
835
2107
  */
836
- isRequired?: boolean | null;
2108
+ token?: string | null;
837
2109
  /**
838
- * The options property
2110
+ * The total_questions property
839
2111
  */
840
- options?: UntypedNode | null;
2112
+ totalQuestions?: number | null;
841
2113
  /**
842
- * The order property
2114
+ * The visit_count property
843
2115
  */
844
- order?: number | null;
2116
+ visitCount?: number | null;
2117
+ }
2118
+ export type RecipientCreateResult_status = (typeof RecipientCreateResult_statusObject)[keyof typeof RecipientCreateResult_statusObject];
2119
+ export interface RecipientResponse extends AdditionalDataHolder, Parsable {
845
2120
  /**
846
- * The priority property
2121
+ * The answeredAt property
847
2122
  */
848
- priority?: Question_priority | null;
2123
+ answeredAt?: Date | null;
849
2124
  /**
850
- * The questionText property
2125
+ * The questionId property
851
2126
  */
852
- questionText?: string | null;
2127
+ questionId?: Guid | null;
853
2128
  /**
854
- * The sectionId property
2129
+ * The updatedAt property
855
2130
  */
856
- sectionId?: Guid | null;
2131
+ updatedAt?: Date | null;
857
2132
  /**
858
- * The type property
2133
+ * Response value. File upload answers may use the FileValue schema for descriptor-style downloads.
859
2134
  */
860
- type?: Question_type | null;
2135
+ value?: UntypedNode | null;
861
2136
  }
862
- export type Question_priority = (typeof Question_priorityObject)[keyof typeof Question_priorityObject];
863
- export type Question_type = (typeof Question_typeObject)[keyof typeof Question_typeObject];
864
- export interface Recipient extends AdditionalDataHolder, Parsable {
2137
+ export interface RecipientUpdate extends AdditionalDataHolder, Parsable {
865
2138
  /**
866
2139
  * The created_at property
867
2140
  */
868
2141
  createdAt?: Date | null;
869
2142
  /**
870
- * The email property
2143
+ * Included when the update service has an email value to return.
871
2144
  */
872
2145
  email?: string | null;
873
2146
  /**
@@ -907,7 +2180,7 @@ export interface Recipient extends AdditionalDataHolder, Parsable {
907
2180
  */
908
2181
  link?: string | null;
909
2182
  /**
910
- * The phone property
2183
+ * Stored phone value; when phone is omitted, an untouched legacy value can be returned.
911
2184
  */
912
2185
  phone?: string | null;
913
2186
  /**
@@ -917,7 +2190,7 @@ export interface Recipient extends AdditionalDataHolder, Parsable {
917
2190
  /**
918
2191
  * The status property
919
2192
  */
920
- status?: Recipient_status | null;
2193
+ status?: RecipientUpdate_status | null;
921
2194
  /**
922
2195
  * The token property
923
2196
  */
@@ -931,25 +2204,7 @@ export interface Recipient extends AdditionalDataHolder, Parsable {
931
2204
  */
932
2205
  visitCount?: number | null;
933
2206
  }
934
- export type Recipient_status = (typeof Recipient_statusObject)[keyof typeof Recipient_statusObject];
935
- export interface RecipientResponse extends AdditionalDataHolder, Parsable {
936
- /**
937
- * The answeredAt property
938
- */
939
- answeredAt?: Date | null;
940
- /**
941
- * The questionId property
942
- */
943
- questionId?: Guid | null;
944
- /**
945
- * The updatedAt property
946
- */
947
- updatedAt?: Date | null;
948
- /**
949
- * The value property
950
- */
951
- value?: UntypedNode | null;
952
- }
2207
+ export type RecipientUpdate_status = (typeof RecipientUpdate_statusObject)[keyof typeof RecipientUpdate_statusObject];
953
2208
  export interface Section extends AdditionalDataHolder, Parsable {
954
2209
  /**
955
2210
  * The createdAt property
@@ -972,6 +2227,41 @@ export interface Section extends AdditionalDataHolder, Parsable {
972
2227
  */
973
2228
  title?: string | null;
974
2229
  }
2230
+ /**
2231
+ * Serializes information the current object
2232
+ * @param ApplyDocumentParseJobResponse The instance to serialize from.
2233
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2234
+ * @param writer Serialization writer to use to serialize this model
2235
+ */
2236
+ export declare function serializeApplyDocumentParseJobResponse(writer: SerializationWriter, applyDocumentParseJobResponse?: Partial<ApplyDocumentParseJobResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
2237
+ /**
2238
+ * Serializes information the current object
2239
+ * @param ApplyDocumentParseJobResponse_meta The instance to serialize from.
2240
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2241
+ * @param writer Serialization writer to use to serialize this model
2242
+ */
2243
+ export declare function serializeApplyDocumentParseJobResponse_meta(writer: SerializationWriter, applyDocumentParseJobResponse_meta?: Partial<ApplyDocumentParseJobResponse_meta> | undefined | null, isSerializingDerivedType?: boolean): void;
2244
+ /**
2245
+ * Serializes information the current object
2246
+ * @param CanonicalDocumentSubmission The instance to serialize from.
2247
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2248
+ * @param writer Serialization writer to use to serialize this model
2249
+ */
2250
+ export declare function serializeCanonicalDocumentSubmission(writer: SerializationWriter, canonicalDocumentSubmission?: Partial<CanonicalDocumentSubmission> | undefined | null, isSerializingDerivedType?: boolean): void;
2251
+ /**
2252
+ * Serializes information the current object
2253
+ * @param CanonicalRecipient The instance to serialize from.
2254
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2255
+ * @param writer Serialization writer to use to serialize this model
2256
+ */
2257
+ export declare function serializeCanonicalRecipient(writer: SerializationWriter, canonicalRecipient?: Partial<CanonicalRecipient> | undefined | null, isSerializingDerivedType?: boolean): void;
2258
+ /**
2259
+ * Serializes information the current object
2260
+ * @param CanonicalSigner The instance to serialize from.
2261
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2262
+ * @param writer Serialization writer to use to serialize this model
2263
+ */
2264
+ export declare function serializeCanonicalSigner(writer: SerializationWriter, canonicalSigner?: Partial<CanonicalSigner> | undefined | null, isSerializingDerivedType?: boolean): void;
975
2265
  /**
976
2266
  * Serializes information the current object
977
2267
  * @param CreateFieldBody The instance to serialize from.
@@ -1035,6 +2325,41 @@ export declare function serializeCreateSignerRoleBody(writer: SerializationWrite
1035
2325
  * @param writer Serialization writer to use to serialize this model
1036
2326
  */
1037
2327
  export declare function serializeCreateSubmissionBody(writer: SerializationWriter, createSubmissionBody?: Partial<CreateSubmissionBody> | undefined | null, isSerializingDerivedType?: boolean): void;
2328
+ /**
2329
+ * Serializes information the current object
2330
+ * @param CreateSubmissionResponse The instance to serialize from.
2331
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2332
+ * @param writer Serialization writer to use to serialize this model
2333
+ */
2334
+ export declare function serializeCreateSubmissionResponse(writer: SerializationWriter, createSubmissionResponse?: Partial<CreateSubmissionResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
2335
+ /**
2336
+ * Serializes information the current object
2337
+ * @param CreateSubmissionResult The instance to serialize from.
2338
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2339
+ * @param writer Serialization writer to use to serialize this model
2340
+ */
2341
+ export declare function serializeCreateSubmissionResult(writer: SerializationWriter, createSubmissionResult?: Partial<CreateSubmissionResult> | undefined | null, isSerializingDerivedType?: boolean): void;
2342
+ /**
2343
+ * Serializes information the current object
2344
+ * @param CreateSubmissionSignerResult The instance to serialize from.
2345
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2346
+ * @param writer Serialization writer to use to serialize this model
2347
+ */
2348
+ export declare function serializeCreateSubmissionSignerResult(writer: SerializationWriter, createSubmissionSignerResult?: Partial<CreateSubmissionSignerResult> | undefined | null, isSerializingDerivedType?: boolean): void;
2349
+ /**
2350
+ * Serializes information the current object
2351
+ * @param DetectedDocumentField The instance to serialize from.
2352
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2353
+ * @param writer Serialization writer to use to serialize this model
2354
+ */
2355
+ export declare function serializeDetectedDocumentField(writer: SerializationWriter, detectedDocumentField?: Partial<DetectedDocumentField> | undefined | null, isSerializingDerivedType?: boolean): void;
2356
+ /**
2357
+ * Serializes information the current object
2358
+ * @param DetectedDocumentField_rect The instance to serialize from.
2359
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2360
+ * @param writer Serialization writer to use to serialize this model
2361
+ */
2362
+ export declare function serializeDetectedDocumentField_rect(writer: SerializationWriter, detectedDocumentField_rect?: Partial<DetectedDocumentField_rect> | undefined | null, isSerializingDerivedType?: boolean): void;
1038
2363
  /**
1039
2364
  * Serializes information the current object
1040
2365
  * @param Document The instance to serialize from.
@@ -1063,55 +2388,209 @@ export declare function serializeDocumentField(writer: SerializationWriter, docu
1063
2388
  * @param writer Serialization writer to use to serialize this model
1064
2389
  */
1065
2390
  export declare function serializeDocumentField_options(writer: SerializationWriter, documentField_options?: Partial<DocumentField_options> | undefined | null, isSerializingDerivedType?: boolean): void;
2391
+ /**
2392
+ * Serializes information the current object
2393
+ * @param DocumentNotEditableConflict The instance to serialize from.
2394
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2395
+ * @param writer Serialization writer to use to serialize this model
2396
+ */
2397
+ export declare function serializeDocumentNotEditableConflict(writer: SerializationWriter, documentNotEditableConflict?: Partial<DocumentNotEditableConflict> | undefined | null, isSerializingDerivedType?: boolean): void;
2398
+ /**
2399
+ * Serializes information the current object
2400
+ * @param DocumentParseJobResult The instance to serialize from.
2401
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2402
+ * @param writer Serialization writer to use to serialize this model
2403
+ */
2404
+ export declare function serializeDocumentParseJobResult(writer: SerializationWriter, documentParseJobResult?: Partial<DocumentParseJobResult> | undefined | null, isSerializingDerivedType?: boolean): void;
2405
+ /**
2406
+ * Serializes information the current object
2407
+ * @param DocumentParseJobResult_stats The instance to serialize from.
2408
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2409
+ * @param writer Serialization writer to use to serialize this model
2410
+ */
2411
+ export declare function serializeDocumentParseJobResult_stats(writer: SerializationWriter, documentParseJobResult_stats?: Partial<DocumentParseJobResult_stats> | undefined | null, isSerializingDerivedType?: boolean): void;
2412
+ /**
2413
+ * Serializes information the current object
2414
+ * @param DocumentRevision The instance to serialize from.
2415
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2416
+ * @param writer Serialization writer to use to serialize this model
2417
+ */
2418
+ export declare function serializeDocumentRevision(writer: SerializationWriter, documentRevision?: Partial<DocumentRevision> | undefined | null, isSerializingDerivedType?: boolean): void;
1066
2419
  /**
1067
2420
  * Serializes information the current object
1068
2421
  * @param DocumentSubmission The instance to serialize from.
1069
2422
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1070
2423
  * @param writer Serialization writer to use to serialize this model
1071
2424
  */
1072
- export declare function serializeDocumentSubmission(writer: SerializationWriter, documentSubmission?: Partial<DocumentSubmission> | undefined | null, isSerializingDerivedType?: boolean): void;
2425
+ export declare function serializeDocumentSubmission(writer: SerializationWriter, documentSubmission?: Partial<DocumentSubmission> | undefined | null, isSerializingDerivedType?: boolean): void;
2426
+ /**
2427
+ * Serializes information the current object
2428
+ * @param DocumentSubmission_signedPdf The instance to serialize from.
2429
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2430
+ * @param writer Serialization writer to use to serialize this model
2431
+ */
2432
+ export declare function serializeDocumentSubmission_signedPdf(writer: SerializationWriter, documentSubmission_signedPdf?: Partial<DocumentSubmission_signedPdf> | undefined | null, isSerializingDerivedType?: boolean): void;
2433
+ /**
2434
+ * Serializes information the current object
2435
+ * @param FileDescriptor The instance to serialize from.
2436
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2437
+ * @param writer Serialization writer to use to serialize this model
2438
+ */
2439
+ export declare function serializeFileDescriptor(writer: SerializationWriter, fileDescriptor?: Partial<FileDescriptor> | undefined | null, isSerializingDerivedType?: boolean): void;
2440
+ /**
2441
+ * Serializes information the current object
2442
+ * @param FileDownload The instance to serialize from.
2443
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2444
+ * @param writer Serialization writer to use to serialize this model
2445
+ */
2446
+ export declare function serializeFileDownload(writer: SerializationWriter, fileDownload?: Partial<FileDownload> | undefined | null, isSerializingDerivedType?: boolean): void;
2447
+ /**
2448
+ * Serializes information the current object
2449
+ * @param FileDownloadResponse The instance to serialize from.
2450
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2451
+ * @param writer Serialization writer to use to serialize this model
2452
+ */
2453
+ export declare function serializeFileDownloadResponse(writer: SerializationWriter, fileDownloadResponse?: Partial<FileDownloadResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
2454
+ /**
2455
+ * Serializes information the current object
2456
+ * @param Form The instance to serialize from.
2457
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2458
+ * @param writer Serialization writer to use to serialize this model
2459
+ */
2460
+ export declare function serializeForm(writer: SerializationWriter, form?: Partial<Form> | undefined | null, isSerializingDerivedType?: boolean): void;
2461
+ /**
2462
+ * Serializes information the current object
2463
+ * @param Form_branding The instance to serialize from.
2464
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2465
+ * @param writer Serialization writer to use to serialize this model
2466
+ */
2467
+ export declare function serializeForm_branding(writer: SerializationWriter, form_branding?: Partial<Form_branding> | undefined | null, isSerializingDerivedType?: boolean): void;
2468
+ /**
2469
+ * Serializes information the current object
2470
+ * @param Form_settings The instance to serialize from.
2471
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2472
+ * @param writer Serialization writer to use to serialize this model
2473
+ */
2474
+ export declare function serializeForm_settings(writer: SerializationWriter, form_settings?: Partial<Form_settings> | undefined | null, isSerializingDerivedType?: boolean): void;
2475
+ /**
2476
+ * Serializes information the current object
2477
+ * @param FormRevision The instance to serialize from.
2478
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2479
+ * @param writer Serialization writer to use to serialize this model
2480
+ */
2481
+ export declare function serializeFormRevision(writer: SerializationWriter, formRevision?: Partial<FormRevision> | undefined | null, isSerializingDerivedType?: boolean): void;
2482
+ /**
2483
+ * Serializes information the current object
2484
+ * @param GetDocumentParseJobResponse The instance to serialize from.
2485
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2486
+ * @param writer Serialization writer to use to serialize this model
2487
+ */
2488
+ export declare function serializeGetDocumentParseJobResponse(writer: SerializationWriter, getDocumentParseJobResponse?: Partial<GetDocumentParseJobResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
2489
+ /**
2490
+ * Serializes information the current object
2491
+ * @param GetDocumentParseJobResponse_data The instance to serialize from.
2492
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2493
+ * @param writer Serialization writer to use to serialize this model
2494
+ */
2495
+ export declare function serializeGetDocumentParseJobResponse_data(writer: SerializationWriter, getDocumentParseJobResponse_data?: Partial<GetDocumentParseJobResponse_data> | undefined | null, isSerializingDerivedType?: boolean): void;
2496
+ /**
2497
+ * Serializes information the current object
2498
+ * @param GetDocumentParseJobResponse_meta The instance to serialize from.
2499
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2500
+ * @param writer Serialization writer to use to serialize this model
2501
+ */
2502
+ export declare function serializeGetDocumentParseJobResponse_meta(writer: SerializationWriter, getDocumentParseJobResponse_meta?: Partial<GetDocumentParseJobResponse_meta> | undefined | null, isSerializingDerivedType?: boolean): void;
2503
+ /**
2504
+ * Serializes information the current object
2505
+ * @param ImportDocumentBundleResponse The instance to serialize from.
2506
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2507
+ * @param writer Serialization writer to use to serialize this model
2508
+ */
2509
+ export declare function serializeImportDocumentBundleResponse(writer: SerializationWriter, importDocumentBundleResponse?: Partial<ImportDocumentBundleResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
2510
+ /**
2511
+ * Serializes information the current object
2512
+ * @param ImportDocumentBundleResponse_data The instance to serialize from.
2513
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2514
+ * @param writer Serialization writer to use to serialize this model
2515
+ */
2516
+ export declare function serializeImportDocumentBundleResponse_data(writer: SerializationWriter, importDocumentBundleResponse_data?: Partial<ImportDocumentBundleResponse_data> | undefined | null, isSerializingDerivedType?: boolean): void;
2517
+ /**
2518
+ * Serializes information the current object
2519
+ * @param ImportDocumentBundleResponse_meta The instance to serialize from.
2520
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2521
+ * @param writer Serialization writer to use to serialize this model
2522
+ */
2523
+ export declare function serializeImportDocumentBundleResponse_meta(writer: SerializationWriter, importDocumentBundleResponse_meta?: Partial<ImportDocumentBundleResponse_meta> | undefined | null, isSerializingDerivedType?: boolean): void;
2524
+ /**
2525
+ * Serializes information the current object
2526
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2527
+ * @param ParseJobAppliedResult The instance to serialize from.
2528
+ * @param writer Serialization writer to use to serialize this model
2529
+ */
2530
+ export declare function serializeParseJobAppliedResult(writer: SerializationWriter, parseJobAppliedResult?: Partial<ParseJobAppliedResult> | undefined | null, isSerializingDerivedType?: boolean): void;
2531
+ /**
2532
+ * Serializes information the current object
2533
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2534
+ * @param PhoneValidationDetails The instance to serialize from.
2535
+ * @param writer Serialization writer to use to serialize this model
2536
+ */
2537
+ export declare function serializePhoneValidationDetails(writer: SerializationWriter, phoneValidationDetails?: Partial<PhoneValidationDetails> | undefined | null, isSerializingDerivedType?: boolean): void;
2538
+ /**
2539
+ * Serializes information the current object
2540
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2541
+ * @param PhoneValidationError The instance to serialize from.
2542
+ * @param writer Serialization writer to use to serialize this model
2543
+ */
2544
+ export declare function serializePhoneValidationError(writer: SerializationWriter, phoneValidationError?: Partial<PhoneValidationError> | undefined | null, isSerializingDerivedType?: boolean): void;
2545
+ /**
2546
+ * Serializes information the current object
2547
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2548
+ * @param Question The instance to serialize from.
2549
+ * @param writer Serialization writer to use to serialize this model
2550
+ */
2551
+ export declare function serializeQuestion(writer: SerializationWriter, question?: Partial<Question> | undefined | null, isSerializingDerivedType?: boolean): void;
1073
2552
  /**
1074
2553
  * Serializes information the current object
1075
- * @param Form The instance to serialize from.
1076
2554
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2555
+ * @param QuotaExceededError The instance to serialize from.
1077
2556
  * @param writer Serialization writer to use to serialize this model
1078
2557
  */
1079
- export declare function serializeForm(writer: SerializationWriter, form?: Partial<Form> | undefined | null, isSerializingDerivedType?: boolean): void;
2558
+ export declare function serializeQuotaExceededError(writer: SerializationWriter, quotaExceededError?: Partial<QuotaExceededError> | undefined | null, isSerializingDerivedType?: boolean): void;
1080
2559
  /**
1081
2560
  * Serializes information the current object
1082
- * @param Form_branding The instance to serialize from.
1083
2561
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2562
+ * @param Recipient The instance to serialize from.
1084
2563
  * @param writer Serialization writer to use to serialize this model
1085
2564
  */
1086
- export declare function serializeForm_branding(writer: SerializationWriter, form_branding?: Partial<Form_branding> | undefined | null, isSerializingDerivedType?: boolean): void;
2565
+ export declare function serializeRecipient(writer: SerializationWriter, recipient?: Partial<Recipient> | undefined | null, isSerializingDerivedType?: boolean): void;
1087
2566
  /**
1088
2567
  * Serializes information the current object
1089
- * @param Form_settings The instance to serialize from.
1090
2568
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2569
+ * @param RecipientBulkCreateResult The instance to serialize from.
1091
2570
  * @param writer Serialization writer to use to serialize this model
1092
2571
  */
1093
- export declare function serializeForm_settings(writer: SerializationWriter, form_settings?: Partial<Form_settings> | undefined | null, isSerializingDerivedType?: boolean): void;
2572
+ export declare function serializeRecipientBulkCreateResult(writer: SerializationWriter, recipientBulkCreateResult?: Partial<RecipientBulkCreateResult> | undefined | null, isSerializingDerivedType?: boolean): void;
1094
2573
  /**
1095
2574
  * Serializes information the current object
1096
2575
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1097
- * @param Question The instance to serialize from.
2576
+ * @param RecipientCreateResult The instance to serialize from.
1098
2577
  * @param writer Serialization writer to use to serialize this model
1099
2578
  */
1100
- export declare function serializeQuestion(writer: SerializationWriter, question?: Partial<Question> | undefined | null, isSerializingDerivedType?: boolean): void;
2579
+ export declare function serializeRecipientCreateResult(writer: SerializationWriter, recipientCreateResult?: Partial<RecipientCreateResult> | undefined | null, isSerializingDerivedType?: boolean): void;
1101
2580
  /**
1102
2581
  * Serializes information the current object
1103
2582
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1104
- * @param Recipient The instance to serialize from.
2583
+ * @param RecipientResponse The instance to serialize from.
1105
2584
  * @param writer Serialization writer to use to serialize this model
1106
2585
  */
1107
- export declare function serializeRecipient(writer: SerializationWriter, recipient?: Partial<Recipient> | undefined | null, isSerializingDerivedType?: boolean): void;
2586
+ export declare function serializeRecipientResponse(writer: SerializationWriter, recipientResponse?: Partial<RecipientResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
1108
2587
  /**
1109
2588
  * Serializes information the current object
1110
2589
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1111
- * @param RecipientResponse The instance to serialize from.
2590
+ * @param RecipientUpdate The instance to serialize from.
1112
2591
  * @param writer Serialization writer to use to serialize this model
1113
2592
  */
1114
- export declare function serializeRecipientResponse(writer: SerializationWriter, recipientResponse?: Partial<RecipientResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
2593
+ export declare function serializeRecipientUpdate(writer: SerializationWriter, recipientUpdate?: Partial<RecipientUpdate> | undefined | null, isSerializingDerivedType?: boolean): void;
1115
2594
  /**
1116
2595
  * Serializes information the current object
1117
2596
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -1154,6 +2633,41 @@ export declare function serializeSignerResponse(writer: SerializationWriter, sig
1154
2633
  * @param writer Serialization writer to use to serialize this model
1155
2634
  */
1156
2635
  export declare function serializeSignerRole(writer: SerializationWriter, signerRole?: Partial<SignerRole> | undefined | null, isSerializingDerivedType?: boolean): void;
2636
+ /**
2637
+ * Serializes information the current object
2638
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2639
+ * @param SignerUpdate The instance to serialize from.
2640
+ * @param writer Serialization writer to use to serialize this model
2641
+ */
2642
+ export declare function serializeSignerUpdate(writer: SerializationWriter, signerUpdate?: Partial<SignerUpdate> | undefined | null, isSerializingDerivedType?: boolean): void;
2643
+ /**
2644
+ * Serializes information the current object
2645
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2646
+ * @param StartDocumentParseJobBody The instance to serialize from.
2647
+ * @param writer Serialization writer to use to serialize this model
2648
+ */
2649
+ export declare function serializeStartDocumentParseJobBody(writer: SerializationWriter, startDocumentParseJobBody?: Partial<StartDocumentParseJobBody> | undefined | null, isSerializingDerivedType?: boolean): void;
2650
+ /**
2651
+ * Serializes information the current object
2652
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2653
+ * @param StartDocumentParseJobResponse The instance to serialize from.
2654
+ * @param writer Serialization writer to use to serialize this model
2655
+ */
2656
+ export declare function serializeStartDocumentParseJobResponse(writer: SerializationWriter, startDocumentParseJobResponse?: Partial<StartDocumentParseJobResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
2657
+ /**
2658
+ * Serializes information the current object
2659
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2660
+ * @param StartDocumentParseJobResponse_data The instance to serialize from.
2661
+ * @param writer Serialization writer to use to serialize this model
2662
+ */
2663
+ export declare function serializeStartDocumentParseJobResponse_data(writer: SerializationWriter, startDocumentParseJobResponse_data?: Partial<StartDocumentParseJobResponse_data> | undefined | null, isSerializingDerivedType?: boolean): void;
2664
+ /**
2665
+ * Serializes information the current object
2666
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2667
+ * @param StartDocumentParseJobResponse_meta The instance to serialize from.
2668
+ * @param writer Serialization writer to use to serialize this model
2669
+ */
2670
+ export declare function serializeStartDocumentParseJobResponse_meta(writer: SerializationWriter, startDocumentParseJobResponse_meta?: Partial<StartDocumentParseJobResponse_meta> | undefined | null, isSerializingDerivedType?: boolean): void;
1157
2671
  /**
1158
2672
  * Serializes information the current object
1159
2673
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -1196,6 +2710,13 @@ export declare function serializeUpdateRecipientResponsesBody_responses(writer:
1196
2710
  * @param writer Serialization writer to use to serialize this model
1197
2711
  */
1198
2712
  export declare function serializeUpdateSectionBody(writer: SerializationWriter, updateSectionBody?: Partial<UpdateSectionBody> | undefined | null, isSerializingDerivedType?: boolean): void;
2713
+ /**
2714
+ * Serializes information the current object
2715
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2716
+ * @param UpdateSignerBody The instance to serialize from.
2717
+ * @param writer Serialization writer to use to serialize this model
2718
+ */
2719
+ export declare function serializeUpdateSignerBody(writer: SerializationWriter, updateSignerBody?: Partial<UpdateSignerBody> | undefined | null, isSerializingDerivedType?: boolean): void;
1199
2720
  /**
1200
2721
  * Serializes information the current object
1201
2722
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -1210,6 +2731,13 @@ export declare function serializeUpdateSignerResponsesBody(writer: Serialization
1210
2731
  * @param writer Serialization writer to use to serialize this model
1211
2732
  */
1212
2733
  export declare function serializeUpdateSignerResponsesBody_responses(writer: SerializationWriter, updateSignerResponsesBody_responses?: Partial<UpdateSignerResponsesBody_responses> | undefined | null, isSerializingDerivedType?: boolean): void;
2734
+ /**
2735
+ * Serializes information the current object
2736
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
2737
+ * @param ValidationError The instance to serialize from.
2738
+ * @param writer Serialization writer to use to serialize this model
2739
+ */
2740
+ export declare function serializeValidationError(writer: SerializationWriter, validationError?: Partial<ValidationError> | undefined | null, isSerializingDerivedType?: boolean): void;
1213
2741
  export interface Signer extends AdditionalDataHolder, Parsable {
1214
2742
  /**
1215
2743
  * The color property
@@ -1240,7 +2768,7 @@ export interface Signer extends AdditionalDataHolder, Parsable {
1240
2768
  */
1241
2769
  label?: string | null;
1242
2770
  /**
1243
- * The link property
2771
+ * Signing link for a live document and signer; null when lifecycle rules withhold access.
1244
2772
  */
1245
2773
  link?: string | null;
1246
2774
  /**
@@ -1251,6 +2779,10 @@ export interface Signer extends AdditionalDataHolder, Parsable {
1251
2779
  * The order property
1252
2780
  */
1253
2781
  order?: number | null;
2782
+ /**
2783
+ * Stored phone value. Legacy list/get records can retain their pre-normalization stored value until corrected.
2784
+ */
2785
+ phone?: string | null;
1254
2786
  /**
1255
2787
  * The role property
1256
2788
  */
@@ -1264,7 +2796,7 @@ export interface Signer extends AdditionalDataHolder, Parsable {
1264
2796
  */
1265
2797
  submissionId?: Guid | null;
1266
2798
  /**
1267
- * The token property
2799
+ * Bearer signing token; omitted when the document or signer is no longer live.
1268
2800
  */
1269
2801
  token?: string | null;
1270
2802
  }
@@ -1283,15 +2815,15 @@ export interface SignerInput extends AdditionalDataHolder, Parsable {
1283
2815
  */
1284
2816
  password?: string | null;
1285
2817
  /**
1286
- * The phone property
2818
+ * Accepted formatted phone input. International input may include spaces, parentheses, and hyphens, but must include `+`. National input uses the workspace default phone country.
1287
2819
  */
1288
2820
  phone?: string | null;
1289
2821
  /**
1290
- * Map of field identifier → pre-filled value. Keys can be field UUIDs or field labels. Label-based keys are resolved against fields assigned to this signer's role. If a label matches multiple fields for the same role, the request is rejected with disambiguation details. Creates DocumentResponse records immediately.
2822
+ * Map of field identifier → pre-filled value. Keys can be field UUIDs or field labels. Label-based keys are resolved against fields assigned to this signer's role. If a label matches multiple fields for the same role, the request is rejected with disambiguation details. At most 100 fields, 10 nesting levels, and 65536 serialized UTF-8 bytes are accepted per signer. Creates DocumentResponse records immediately.
1291
2823
  */
1292
2824
  prefill?: SignerInput_prefill | null;
1293
2825
  /**
1294
- * If true, prefilled fields are marked read-only on the document
2826
+ * If true, prefilled fields are marked read-only for this signer only.
1295
2827
  */
1296
2828
  prefillReadonly?: boolean | null;
1297
2829
  /**
@@ -1304,7 +2836,7 @@ export interface SignerInput extends AdditionalDataHolder, Parsable {
1304
2836
  role?: string | null;
1305
2837
  }
1306
2838
  /**
1307
- * Map of field identifier → pre-filled value. Keys can be field UUIDs or field labels. Label-based keys are resolved against fields assigned to this signer's role. If a label matches multiple fields for the same role, the request is rejected with disambiguation details. Creates DocumentResponse records immediately.
2839
+ * Map of field identifier → pre-filled value. Keys can be field UUIDs or field labels. Label-based keys are resolved against fields assigned to this signer's role. If a label matches multiple fields for the same role, the request is rejected with disambiguation details. At most 100 fields, 10 nesting levels, and 65536 serialized UTF-8 bytes are accepted per signer. Creates DocumentResponse records immediately.
1308
2840
  */
1309
2841
  export interface SignerInput_prefill extends AdditionalDataHolder, Parsable {
1310
2842
  }
@@ -1322,7 +2854,7 @@ export interface SignerResponse extends AdditionalDataHolder, Parsable {
1322
2854
  */
1323
2855
  updatedAt?: Date | null;
1324
2856
  /**
1325
- * The value property
2857
+ * Response value. File upload answers may use the FileValue schema for descriptor-style downloads.
1326
2858
  */
1327
2859
  value?: UntypedNode | null;
1328
2860
  }
@@ -1356,6 +2888,123 @@ export interface SignerRole extends AdditionalDataHolder, Parsable {
1356
2888
  */
1357
2889
  role?: string | null;
1358
2890
  }
2891
+ export interface SignerUpdate extends AdditionalDataHolder, Parsable {
2892
+ /**
2893
+ * The color property
2894
+ */
2895
+ color?: string | null;
2896
+ /**
2897
+ * The completedAt property
2898
+ */
2899
+ completedAt?: Date | null;
2900
+ /**
2901
+ * The createdAt property
2902
+ */
2903
+ createdAt?: Date | null;
2904
+ /**
2905
+ * The documentId property
2906
+ */
2907
+ documentId?: Guid | null;
2908
+ /**
2909
+ * The email property
2910
+ */
2911
+ email?: string | null;
2912
+ /**
2913
+ * The expiresAt property
2914
+ */
2915
+ expiresAt?: Date | null;
2916
+ /**
2917
+ * The id property
2918
+ */
2919
+ id?: Guid | null;
2920
+ /**
2921
+ * The label property
2922
+ */
2923
+ label?: string | null;
2924
+ /**
2925
+ * The name property
2926
+ */
2927
+ name?: string | null;
2928
+ /**
2929
+ * The order property
2930
+ */
2931
+ order?: number | null;
2932
+ /**
2933
+ * Stored phone value; when phone is omitted, an untouched legacy value can be returned.
2934
+ */
2935
+ phone?: string | null;
2936
+ /**
2937
+ * The role property
2938
+ */
2939
+ role?: string | null;
2940
+ /**
2941
+ * The status property
2942
+ */
2943
+ status?: SignerUpdate_status | null;
2944
+ /**
2945
+ * The submissionId property
2946
+ */
2947
+ submissionId?: Guid | null;
2948
+ }
2949
+ export type SignerUpdate_status = (typeof SignerUpdate_statusObject)[keyof typeof SignerUpdate_statusObject];
2950
+ export interface StartDocumentParseJobBody extends AdditionalDataHolder, Parsable {
2951
+ /**
2952
+ * The applyMode property
2953
+ */
2954
+ applyMode?: StartDocumentParseJobBody_applyMode | null;
2955
+ /**
2956
+ * The confirmAiParse property
2957
+ */
2958
+ confirmAiParse?: boolean | null;
2959
+ }
2960
+ export type StartDocumentParseJobBody_applyMode = (typeof StartDocumentParseJobBody_applyModeObject)[keyof typeof StartDocumentParseJobBody_applyModeObject];
2961
+ export interface StartDocumentParseJobResponse extends AdditionalDataHolder, Parsable {
2962
+ /**
2963
+ * The data property
2964
+ */
2965
+ data?: StartDocumentParseJobResponse_data | null;
2966
+ /**
2967
+ * The meta property
2968
+ */
2969
+ meta?: StartDocumentParseJobResponse_meta | null;
2970
+ /**
2971
+ * The success property
2972
+ */
2973
+ success?: boolean | null;
2974
+ }
2975
+ export interface StartDocumentParseJobResponse_data extends AdditionalDataHolder, Parsable {
2976
+ /**
2977
+ * The documentId property
2978
+ */
2979
+ documentId?: Guid | null;
2980
+ /**
2981
+ * The parseJobId property
2982
+ */
2983
+ parseJobId?: Guid | null;
2984
+ /**
2985
+ * The pollAfterMs property
2986
+ */
2987
+ pollAfterMs?: number | null;
2988
+ /**
2989
+ * The status property
2990
+ */
2991
+ status?: StartDocumentParseJobResponse_data_status | null;
2992
+ }
2993
+ export type StartDocumentParseJobResponse_data_status = (typeof StartDocumentParseJobResponse_data_statusObject)[keyof typeof StartDocumentParseJobResponse_data_statusObject];
2994
+ export interface StartDocumentParseJobResponse_meta extends AdditionalDataHolder, Parsable {
2995
+ /**
2996
+ * The limit property
2997
+ */
2998
+ limit?: number | null;
2999
+ /**
3000
+ * The page property
3001
+ */
3002
+ page?: number | null;
3003
+ /**
3004
+ * Total number of records
3005
+ */
3006
+ total?: number | null;
3007
+ }
1359
3008
  export interface SubmissionPdf extends AdditionalDataHolder, Parsable {
1360
3009
  /**
1361
3010
  * The completedAt property
@@ -1369,6 +3018,10 @@ export interface SubmissionPdf extends AdditionalDataHolder, Parsable {
1369
3018
  * URL expiry in seconds
1370
3019
  */
1371
3020
  expiresIn?: number | null;
3021
+ /**
3022
+ * The file property
3023
+ */
3024
+ file?: FileDescriptor | null;
1372
3025
  /**
1373
3026
  * The submissionId property
1374
3027
  */
@@ -1390,12 +3043,16 @@ export interface UpdateFormBody extends AdditionalDataHolder, Parsable {
1390
3043
  }
1391
3044
  export type UpdateFormBody_status = (typeof UpdateFormBody_statusObject)[keyof typeof UpdateFormBody_statusObject];
1392
3045
  export interface UpdateRecipientBody extends AdditionalDataHolder, Parsable {
3046
+ /**
3047
+ * Set true to clear the stored phone. Omit to leave it unchanged; cannot be combined with a non-null phone.
3048
+ */
3049
+ clearPhone?: boolean | null;
1393
3050
  /**
1394
3051
  * The email property
1395
3052
  */
1396
3053
  email?: string | null;
1397
3054
  /**
1398
- * The expires_at property
3055
+ * ISO 8601 expiry; null clears it.
1399
3056
  */
1400
3057
  expiresAt?: Date | null;
1401
3058
  /**
@@ -1407,11 +3064,11 @@ export interface UpdateRecipientBody extends AdditionalDataHolder, Parsable {
1407
3064
  */
1408
3065
  label?: string | null;
1409
3066
  /**
1410
- * null to remove password
3067
+ * Write-only; null removes the password.
1411
3068
  */
1412
3069
  password?: string | null;
1413
3070
  /**
1414
- * The phone property
3071
+ * Accepted formatted phone input. International input may include spaces, parentheses, and hyphens, but must include `+`. National input uses the workspace default phone country.
1415
3072
  */
1416
3073
  phone?: string | null;
1417
3074
  }
@@ -1436,6 +3093,48 @@ export interface UpdateSectionBody extends AdditionalDataHolder, Parsable {
1436
3093
  */
1437
3094
  title?: string | null;
1438
3095
  }
3096
+ export interface UpdateSignerBody extends AdditionalDataHolder, Parsable {
3097
+ /**
3098
+ * Set true to clear the stored phone. Omit to leave it unchanged; cannot be combined with a non-null phone.
3099
+ */
3100
+ clearPhone?: boolean | null;
3101
+ /**
3102
+ * The color property
3103
+ */
3104
+ color?: string | null;
3105
+ /**
3106
+ * The email property
3107
+ */
3108
+ email?: string | null;
3109
+ /**
3110
+ * ISO 8601 expiry; null clears it.
3111
+ */
3112
+ expiresAt?: Date | null;
3113
+ /**
3114
+ * The label property
3115
+ */
3116
+ label?: string | null;
3117
+ /**
3118
+ * The name property
3119
+ */
3120
+ name?: string | null;
3121
+ /**
3122
+ * The order property
3123
+ */
3124
+ order?: number | null;
3125
+ /**
3126
+ * Write-only password; null removes it and it is never returned.
3127
+ */
3128
+ password?: string | null;
3129
+ /**
3130
+ * Accepted formatted phone input. International input may include spaces, parentheses, and hyphens, but must include `+`. National input uses the workspace default phone country.
3131
+ */
3132
+ phone?: string | null;
3133
+ /**
3134
+ * The role property
3135
+ */
3136
+ role?: string | null;
3137
+ }
1439
3138
  export interface UpdateSignerResponsesBody extends AdditionalDataHolder, Parsable {
1440
3139
  /**
1441
3140
  * Map of field ID → new value. Performs upsert on DocumentResponse records.
@@ -1447,6 +3146,28 @@ export interface UpdateSignerResponsesBody extends AdditionalDataHolder, Parsabl
1447
3146
  */
1448
3147
  export interface UpdateSignerResponsesBody_responses extends AdditionalDataHolder, Parsable {
1449
3148
  }
3149
+ export interface ValidationError extends AdditionalDataHolder, ApiError, Parsable {
3150
+ /**
3151
+ * Stable machine-readable error code when available.
3152
+ */
3153
+ code?: string | null;
3154
+ /**
3155
+ * The details property
3156
+ */
3157
+ details?: PhoneValidationDetails | null;
3158
+ /**
3159
+ * The error property
3160
+ */
3161
+ errorEscaped?: string | null;
3162
+ /**
3163
+ * The hint property
3164
+ */
3165
+ hint?: string | null;
3166
+ /**
3167
+ * The success property
3168
+ */
3169
+ success?: boolean | null;
3170
+ }
1450
3171
  export declare const CreateFieldBody_directionObject: {
1451
3172
  readonly Auto: "auto";
1452
3173
  readonly Rtl: "rtl";
@@ -1467,6 +3188,7 @@ export declare const CreateFieldBody_typeObject: {
1467
3188
  readonly Email: "email";
1468
3189
  readonly Phone: "phone";
1469
3190
  readonly Initials: "initials";
3191
+ readonly Calculation: "calculation";
1470
3192
  };
1471
3193
  export declare const CreateQuestionBody_priorityObject: {
1472
3194
  readonly Low: "low";
@@ -1505,11 +3227,36 @@ export declare const CreateQuestionBody_typeObject: {
1505
3227
  readonly Calculation: "calculation";
1506
3228
  readonly Payment: "payment";
1507
3229
  };
3230
+ /**
3231
+ * Signing experience used by generated links. Defaults to the document signing view.
3232
+ */
3233
+ export declare const CreateSubmissionBody_deliveryFormatObject: {
3234
+ readonly Document: "document";
3235
+ readonly Form: "form";
3236
+ };
3237
+ export declare const DetectedDocumentField_typeObject: {
3238
+ readonly Short_text: "short_text";
3239
+ readonly Long_text: "long_text";
3240
+ readonly Mcq: "mcq";
3241
+ readonly Multi_select: "multi_select";
3242
+ readonly Rating: "rating";
3243
+ readonly Date: "date";
3244
+ readonly Number: "number";
3245
+ readonly Yes_no: "yes_no";
3246
+ readonly File_upload: "file_upload";
3247
+ readonly Dropdown: "dropdown";
3248
+ readonly Digital_signature: "digital_signature";
3249
+ readonly Email: "email";
3250
+ readonly Phone: "phone";
3251
+ readonly Initials: "initials";
3252
+ readonly Calculation: "calculation";
3253
+ };
1508
3254
  export declare const Document_statusObject: {
1509
3255
  readonly Draft: "draft";
1510
3256
  readonly Published: "published";
1511
3257
  readonly Completed: "completed";
1512
3258
  readonly Expired: "expired";
3259
+ readonly Voided: "voided";
1513
3260
  };
1514
3261
  export declare const DocumentField_directionObject: {
1515
3262
  readonly Auto: "auto";
@@ -1531,17 +3278,58 @@ export declare const DocumentField_typeObject: {
1531
3278
  readonly Email: "email";
1532
3279
  readonly Phone: "phone";
1533
3280
  readonly Initials: "initials";
3281
+ readonly Calculation: "calculation";
3282
+ };
3283
+ export declare const DocumentNotEditableConflict_codeObject: {
3284
+ readonly Document_not_editable: "document_not_editable";
3285
+ };
3286
+ export declare const DocumentSubmission_signedPdf_authorizationObject: {
3287
+ readonly BearerFormalingoAPIKey: "Bearer Formalingo API key";
3288
+ };
3289
+ export declare const DocumentSubmission_signedPdf_downloadMethodObject: {
3290
+ readonly GET: "GET";
1534
3291
  };
1535
3292
  export declare const DocumentSubmission_statusObject: {
1536
3293
  readonly Pending: "pending";
1537
3294
  readonly In_progress: "in_progress";
1538
3295
  readonly Completed: "completed";
1539
3296
  };
3297
+ export declare const FileDescriptor_authorizationObject: {
3298
+ readonly BearerFormalingoAPIKey: "Bearer Formalingo API key";
3299
+ };
3300
+ export declare const FileDescriptor_downloadMethodObject: {
3301
+ readonly GET: "GET";
3302
+ };
1540
3303
  export declare const Form_statusObject: {
1541
3304
  readonly Draft: "draft";
1542
3305
  readonly Published: "published";
1543
3306
  readonly Archived: "archived";
1544
3307
  };
3308
+ export declare const GetDocumentParseJobResponse_data_applyModeObject: {
3309
+ readonly Draft: "draft";
3310
+ readonly Preview: "preview";
3311
+ };
3312
+ export declare const GetDocumentParseJobResponse_data_statusObject: {
3313
+ readonly Pending: "pending";
3314
+ readonly Processing: "processing";
3315
+ readonly Completed: "completed";
3316
+ readonly Failed: "failed";
3317
+ };
3318
+ export declare const ImportDocumentBundleResponse_data_generationTypeObject: {
3319
+ readonly Uploaded: "uploaded";
3320
+ readonly Generated: "generated";
3321
+ };
3322
+ export declare const ImportDocumentBundleResponse_data_statusObject: {
3323
+ readonly Draft: "draft";
3324
+ };
3325
+ /**
3326
+ * Stable phone-normalization failure code.
3327
+ */
3328
+ export declare const PhoneValidationDetails_codeObject: {
3329
+ readonly Missing_default_country: "missing_default_country";
3330
+ readonly Invalid_country: "invalid_country";
3331
+ readonly Invalid_phone: "invalid_phone";
3332
+ };
1545
3333
  export declare const Question_priorityObject: {
1546
3334
  readonly Low: "low";
1547
3335
  readonly Medium: "medium";
@@ -1579,16 +3367,52 @@ export declare const Question_typeObject: {
1579
3367
  readonly Calculation: "calculation";
1580
3368
  readonly Payment: "payment";
1581
3369
  };
3370
+ /**
3371
+ * The requested operation would exceed a workspace plan limit.
3372
+ */
3373
+ export declare const QuotaExceededError_codeObject: {
3374
+ readonly Quota_exceeded: "quota_exceeded";
3375
+ };
1582
3376
  export declare const Recipient_statusObject: {
1583
3377
  readonly Not_started: "not_started";
1584
3378
  readonly In_progress: "in_progress";
1585
3379
  readonly Completed: "completed";
1586
3380
  };
3381
+ export declare const RecipientBulkCreateResult_statusObject: {
3382
+ readonly Not_started: "not_started";
3383
+ readonly In_progress: "in_progress";
3384
+ readonly Completed: "completed";
3385
+ };
3386
+ export declare const RecipientCreateResult_statusObject: {
3387
+ readonly Not_started: "not_started";
3388
+ readonly In_progress: "in_progress";
3389
+ readonly Completed: "completed";
3390
+ };
3391
+ export declare const RecipientUpdate_statusObject: {
3392
+ readonly Not_started: "not_started";
3393
+ readonly In_progress: "in_progress";
3394
+ readonly Completed: "completed";
3395
+ };
1587
3396
  export declare const Signer_statusObject: {
1588
3397
  readonly Pending: "pending";
1589
3398
  readonly Viewed: "viewed";
1590
3399
  readonly Completed: "completed";
1591
3400
  };
3401
+ export declare const SignerUpdate_statusObject: {
3402
+ readonly Pending: "pending";
3403
+ readonly Viewed: "viewed";
3404
+ readonly Completed: "completed";
3405
+ };
3406
+ export declare const StartDocumentParseJobBody_applyModeObject: {
3407
+ readonly Draft: "draft";
3408
+ readonly Preview: "preview";
3409
+ };
3410
+ export declare const StartDocumentParseJobResponse_data_statusObject: {
3411
+ readonly Pending: "pending";
3412
+ readonly Processing: "processing";
3413
+ readonly Completed: "completed";
3414
+ readonly Failed: "failed";
3415
+ };
1592
3416
  export declare const UpdateFormBody_statusObject: {
1593
3417
  readonly Draft: "draft";
1594
3418
  readonly Published: "published";