@@ -18,6 +18,7 @@ public class SignRequest: SignRequestBase {
1818 case shortId = " short_id "
1919 case createdAt = " created_at "
2020 case finishedAt = " finished_at "
21+ case errorCode = " error_code "
2122 case senderEmail = " sender_email "
2223 case senderId = " sender_id "
2324 }
@@ -81,6 +82,10 @@ public class SignRequest: SignRequestBase {
8182 /// Timestamp indicating when all signing actions completed.
8283 @CodableTriState public private( set) var finishedAt : Date ?
8384
85+ /// When the sign request is in an error state, identifies the specific
86+ /// reason. Null when no error code applies.
87+ @CodableTriState public private( set) var errorCode : String ?
88+
8489 /// The email address of the sender of the sign request.
8590 @CodableTriState public private( set) var senderEmail : String ?
8691
@@ -125,9 +130,11 @@ public class SignRequest: SignRequestBase {
125130 /// - shortId: Short identifier for the sign request.
126131 /// - createdAt: Timestamp marking when the sign request was created.
127132 /// - finishedAt: Timestamp indicating when all signing actions completed.
133+ /// - errorCode: When the sign request is in an error state, identifies the specific
134+ /// reason. Null when no error code applies.
128135 /// - senderEmail: The email address of the sender of the sign request.
129136 /// - senderId: The user ID of the sender of the sign request.
130- public init ( isDocumentPreparationNeeded: Bool ? = nil , redirectUrl: TriStateField < String > = nil , declinedRedirectUrl: TriStateField < String > = nil , areTextSignaturesEnabled: Bool ? = nil , emailSubject: TriStateField < String > = nil , emailMessage: TriStateField < String > = nil , areRemindersEnabled: Bool ? = nil , name: String ? = nil , prefillTags: [ SignRequestPrefillTag ] ? = nil , daysValid: TriStateField < Int64 > = nil , externalId: TriStateField < String > = nil , templateId: TriStateField < String > = nil , externalSystemName: TriStateField < String > = nil , type: SignRequestTypeField ? = nil , sourceFiles: [ FileBase ] ? = nil , signers: [ SignRequestSigner ] ? = nil , signatureColor: TriStateField < String > = nil , id: String ? = nil , prepareUrl: TriStateField < String > = nil , signingLog: FileMini ? = nil , status: SignRequestStatusField ? = nil , signFiles: SignRequestSignFilesField ? = nil , autoExpireAt: TriStateField < Date > = nil , parentFolder: FolderMini ? = nil , collaboratorLevel: TriStateField < String > = nil , shortId: String ? = nil , createdAt: Date ? = nil , finishedAt: TriStateField < Date > = nil , senderEmail: TriStateField < String > = nil , senderId: TriStateField < Int64 > = nil ) {
137+ public init ( isDocumentPreparationNeeded: Bool ? = nil , redirectUrl: TriStateField < String > = nil , declinedRedirectUrl: TriStateField < String > = nil , areTextSignaturesEnabled: Bool ? = nil , emailSubject: TriStateField < String > = nil , emailMessage: TriStateField < String > = nil , areRemindersEnabled: Bool ? = nil , name: String ? = nil , prefillTags: [ SignRequestPrefillTag ] ? = nil , daysValid: TriStateField < Int64 > = nil , externalId: TriStateField < String > = nil , templateId: TriStateField < String > = nil , externalSystemName: TriStateField < String > = nil , type: SignRequestTypeField ? = nil , sourceFiles: [ FileBase ] ? = nil , signers: [ SignRequestSigner ] ? = nil , signatureColor: TriStateField < String > = nil , id: String ? = nil , prepareUrl: TriStateField < String > = nil , signingLog: FileMini ? = nil , status: SignRequestStatusField ? = nil , signFiles: SignRequestSignFilesField ? = nil , autoExpireAt: TriStateField < Date > = nil , parentFolder: FolderMini ? = nil , collaboratorLevel: TriStateField < String > = nil , shortId: String ? = nil , createdAt: Date ? = nil , finishedAt: TriStateField < Date > = nil , errorCode: TriStateField < String > = nil , senderEmail: TriStateField < String > = nil , senderId: TriStateField < Int64 > = nil ) {
131138 self . type = type
132139 self . sourceFiles = sourceFiles
133140 self . signers = signers
@@ -143,6 +150,7 @@ public class SignRequest: SignRequestBase {
143150 self . shortId = shortId
144151 self . createdAt = createdAt
145152 self . _finishedAt = CodableTriState ( state: finishedAt)
153+ self . _errorCode = CodableTriState ( state: errorCode)
146154 self . _senderEmail = CodableTriState ( state: senderEmail)
147155 self . _senderId = CodableTriState ( state: senderId)
148156
@@ -166,6 +174,7 @@ public class SignRequest: SignRequestBase {
166174 shortId = try container. decodeIfPresent ( String . self, forKey: . shortId)
167175 createdAt = try container. decodeDateTimeIfPresent ( forKey: . createdAt)
168176 finishedAt = try container. decodeDateTimeIfPresent ( forKey: . finishedAt)
177+ errorCode = try container. decodeIfPresent ( String . self, forKey: . errorCode)
169178 senderEmail = try container. decodeIfPresent ( String . self, forKey: . senderEmail)
170179 senderId = try container. decodeIfPresent ( Int64 . self, forKey: . senderId)
171180
@@ -189,6 +198,7 @@ public class SignRequest: SignRequestBase {
189198 try container. encodeIfPresent ( shortId, forKey: . shortId)
190199 try container. encodeDateTimeIfPresent ( field: createdAt, forKey: . createdAt)
191200 try container. encodeDateTime ( field: _finishedAt. state, forKey: . finishedAt)
201+ try container. encode ( field: _errorCode. state, forKey: . errorCode)
192202 try container. encode ( field: _senderEmail. state, forKey: . senderEmail)
193203 try container. encode ( field: _senderId. state, forKey: . senderId)
194204 try super. encode ( to: encoder)
0 commit comments