feat: add new sign request metadata (box/box-openapi#565)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "49f3695", "specHash": "e7ce024", "version": "5.1.0" }
+{ "engineHash": "49f3695", "specHash": "7e4908e", "version": "5.1.0" }

src/main/java/com/box/sdkgen/schemas/signrequest/SignRequest.java

@@ -90,6 +90,23 @@ public class SignRequest extends SignRequestBase {
   @Nullable
   protected String collaboratorLevel;
 
+  /** Short identifier for the sign request. */
+  @JsonProperty("short_id")
+  protected String shortId;
+
+  /** Timestamp marking when the sign request was created. */
+  @JsonProperty("created_at")
+  @JsonSerialize(using = DateTimeUtils.DateTimeSerializer.class)
+  @JsonDeserialize(using = DateTimeUtils.DateTimeDeserializer.class)
+  protected OffsetDateTime createdAt;
+
+  /** Timestamp indicating when all signing actions completed. */
+  @JsonProperty("finished_at")
+  @JsonSerialize(using = DateTimeUtils.DateTimeSerializer.class)
+  @JsonDeserialize(using = DateTimeUtils.DateTimeDeserializer.class)
+  @Nullable
+  protected OffsetDateTime finishedAt;
+
   /** The email address of the sender of the sign request. */
   @JsonProperty("sender_email")
   @Nullable
@@ -118,6 +135,9 @@ protected SignRequest(Builder builder) {
     this.autoExpireAt = builder.autoExpireAt;
     this.parentFolder = builder.parentFolder;
     this.collaboratorLevel = builder.collaboratorLevel;
+    this.shortId = builder.shortId;
+    this.createdAt = builder.createdAt;
+    this.finishedAt = builder.finishedAt;
     this.senderEmail = builder.senderEmail;
     this.senderId = builder.senderId;
     markNullableFieldsAsSet(builder.getExplicitlySetNullableFields());
@@ -171,6 +191,18 @@ public String getCollaboratorLevel() {
     return collaboratorLevel;
   }
 
+  public String getShortId() {
+    return shortId;
+  }
+
+  public OffsetDateTime getCreatedAt() {
+    return createdAt;
+  }
+
+  public OffsetDateTime getFinishedAt() {
+    return finishedAt;
+  }
+
   public String getSenderEmail() {
     return senderEmail;
   }
@@ -213,6 +245,9 @@ public boolean equals(Object o) {
         && Objects.equals(autoExpireAt, casted.autoExpireAt)
         && Objects.equals(parentFolder, casted.parentFolder)
         && Objects.equals(collaboratorLevel, casted.collaboratorLevel)
+        && Objects.equals(shortId, casted.shortId)
+        && Objects.equals(createdAt, casted.createdAt)
+        && Objects.equals(finishedAt, casted.finishedAt)
         && Objects.equals(senderEmail, casted.senderEmail)
         && Objects.equals(senderId, casted.senderId);
   }
@@ -245,6 +280,9 @@ public int hashCode() {
         autoExpireAt,
         parentFolder,
         collaboratorLevel,
+        shortId,
+        createdAt,
+        finishedAt,
         senderEmail,
         senderId);
   }
@@ -352,6 +390,18 @@ public String toString() {
         + collaboratorLevel
         + '\''
         + ", "
+        + "shortId='"
+        + shortId
+        + '\''
+        + ", "
+        + "createdAt='"
+        + createdAt
+        + '\''
+        + ", "
+        + "finishedAt='"
+        + finishedAt
+        + '\''
+        + ", "
         + "senderEmail='"
         + senderEmail
         + '\''
@@ -388,6 +438,12 @@ public static class Builder extends SignRequestBase.Builder {
 
     protected String collaboratorLevel;
 
+    protected String shortId;
+
+    protected OffsetDateTime createdAt;
+
+    protected OffsetDateTime finishedAt;
+
     protected String senderEmail;
 
     protected Long senderId;
@@ -466,6 +522,22 @@ public Builder collaboratorLevel(String collaboratorLevel) {
       return this;
     }
 
+    public Builder shortId(String shortId) {
+      this.shortId = shortId;
+      return this;
+    }
+
+    public Builder createdAt(OffsetDateTime createdAt) {
+      this.createdAt = createdAt;
+      return this;
+    }
+
+    public Builder finishedAt(OffsetDateTime finishedAt) {
+      this.finishedAt = finishedAt;
+      this.markNullableFieldAsSet("finished_at");
+      return this;
+    }
+
     public Builder senderEmail(String senderEmail) {
       this.senderEmail = senderEmail;
       this.markNullableFieldAsSet("sender_email");

src/main/java/com/box/sdkgen/schemas/signrequestsigner/SignRequestSigner.java

@@ -3,6 +3,7 @@
 import com.box.sdkgen.internal.Nullable;
 import com.box.sdkgen.schemas.signrequestcreatesigner.SignRequestCreateSigner;
 import com.box.sdkgen.schemas.signrequestcreatesigner.SignRequestCreateSignerRoleField;
+import com.box.sdkgen.schemas.signrequestsignerattachment.SignRequestSignerAttachment;
 import com.box.sdkgen.schemas.signrequestsignerinput.SignRequestSignerInput;
 import com.box.sdkgen.serialization.json.EnumWrapper;
 import com.fasterxml.jackson.annotation.JsonFilter;
@@ -39,6 +40,9 @@ public class SignRequestSigner extends SignRequestCreateSigner {
   @Nullable
   protected String iframeableEmbedUrl;
 
+  /** Attachments that the signer uploaded. */
+  @Nullable protected List<SignRequestSignerAttachment> attachments;
+
   public SignRequestSigner() {
     super();
   }
@@ -50,6 +54,7 @@ protected SignRequestSigner(Builder builder) {
     this.inputs = builder.inputs;
     this.embedUrl = builder.embedUrl;
     this.iframeableEmbedUrl = builder.iframeableEmbedUrl;
+    this.attachments = builder.attachments;
     markNullableFieldsAsSet(builder.getExplicitlySetNullableFields());
   }
 
@@ -73,6 +78,10 @@ public String getIframeableEmbedUrl() {
     return iframeableEmbedUrl;
   }
 
+  public List<SignRequestSignerAttachment> getAttachments() {
+    return attachments;
+  }
+
   @Override
   public boolean equals(Object o) {
     if (this == o) {
@@ -98,7 +107,8 @@ public boolean equals(Object o) {
         && Objects.equals(signerDecision, casted.signerDecision)
         && Objects.equals(inputs, casted.inputs)
         && Objects.equals(embedUrl, casted.embedUrl)
-        && Objects.equals(iframeableEmbedUrl, casted.iframeableEmbedUrl);
+        && Objects.equals(iframeableEmbedUrl, casted.iframeableEmbedUrl)
+        && Objects.equals(attachments, casted.attachments);
   }
 
   @Override
@@ -120,7 +130,8 @@ public int hashCode() {
         signerDecision,
         inputs,
         embedUrl,
-        iframeableEmbedUrl);
+        iframeableEmbedUrl,
+        attachments);
   }
 
   @Override
@@ -193,6 +204,10 @@ public String toString() {
         + "iframeableEmbedUrl='"
         + iframeableEmbedUrl
         + '\''
+        + ", "
+        + "attachments='"
+        + attachments
+        + '\''
         + "}";
   }
 
@@ -208,6 +223,8 @@ public static class Builder extends SignRequestCreateSigner.Builder {
 
     protected String iframeableEmbedUrl;
 
+    protected List<SignRequestSignerAttachment> attachments;
+
     public Builder hasViewedDocument(Boolean hasViewedDocument) {
       this.hasViewedDocument = hasViewedDocument;
       return this;
@@ -236,6 +253,12 @@ public Builder iframeableEmbedUrl(String iframeableEmbedUrl) {
       return this;
     }
 
+    public Builder attachments(List<SignRequestSignerAttachment> attachments) {
+      this.attachments = attachments;
+      this.markNullableFieldAsSet("attachments");
+      return this;
+    }
+
     @Override
     public Builder email(String email) {
       this.email = email;

src/main/java/com/box/sdkgen/schemas/signrequestsignerattachment/SignRequestSignerAttachment.java

@@ -0,0 +1,90 @@
+package com.box.sdkgen.schemas.signrequestsignerattachment;
+
+import com.box.sdkgen.internal.Nullable;
+import com.box.sdkgen.internal.NullableFieldTracker;
+import com.box.sdkgen.internal.SerializableObject;
+import com.fasterxml.jackson.annotation.JsonFilter;
+import java.util.Objects;
+
+/** Metadata describing a file uploaded by a signer as an attachment. */
+@JsonFilter("nullablePropertyFilter")
+public class SignRequestSignerAttachment extends SerializableObject {
+
+  /** Identifier of the attachment file. */
+  @Nullable protected String id;
+
+  /** Display name of the attachment file. */
+  @Nullable protected String name;
+
+  public SignRequestSignerAttachment() {
+    super();
+  }
+
+  protected SignRequestSignerAttachment(Builder builder) {
+    super();
+    this.id = builder.id;
+    this.name = builder.name;
+    markNullableFieldsAsSet(builder.getExplicitlySetNullableFields());
+  }
+
+  public String getId() {
+    return id;
+  }
+
+  public String getName() {
+    return name;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) {
+      return true;
+    }
+    if (o == null || getClass() != o.getClass()) {
+      return false;
+    }
+    SignRequestSignerAttachment casted = (SignRequestSignerAttachment) o;
+    return Objects.equals(id, casted.id) && Objects.equals(name, casted.name);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(id, name);
+  }
+
+  @Override
+  public String toString() {
+    return "SignRequestSignerAttachment{"
+        + "id='"
+        + id
+        + '\''
+        + ", "
+        + "name='"
+        + name
+        + '\''
+        + "}";
+  }
+
+  public static class Builder extends NullableFieldTracker {
+
+    protected String id;
+
+    protected String name;
+
+    public Builder id(String id) {
+      this.id = id;
+      this.markNullableFieldAsSet("id");
+      return this;
+    }
+
+    public Builder name(String name) {
+      this.name = name;
+      this.markNullableFieldAsSet("name");
+      return this;
+    }
+
+    public SignRequestSignerAttachment build() {
+      return new SignRequestSignerAttachment(this);
+    }
+  }
+}