#5762

Committed 01 Dec 2025 10:27AM UTC coverage: 13.282% (-0.02%) from 13.3%

Build # #5762

Build Type

push

github

Committed by

web-flow

Commit Message

feat(boxsdkgen): Support new sign request metadata (box/box-openapi#565) (#1598)

Run Details

0 of 48 new or added lines in 3 files covered. (0.0%)

15 existing lines in 9 files now uncovered.

8368 of 63001 relevant lines covered (13.28%)

0.13 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

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

package com.box.sdkgen.schemas.signrequestsigner;

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;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.List;
import java.util.Objects;

/** The schema for a Signer object used on the body of a Box Sign request object. */
@JsonFilter("nullablePropertyFilter")
public class SignRequestSigner extends SignRequestCreateSigner {

  /** Set to `true` if the signer views the document. */
  @JsonProperty("has_viewed_document")
  protected Boolean hasViewedDocument;

  /** Final decision made by the signer. */
  @JsonProperty("signer_decision")
  @Nullable
  protected SignRequestSignerSignerDecisionField signerDecision;

  protected List<SignRequestSignerInput> inputs;

  /** URL to direct a signer to for signing. */
  @JsonProperty("embed_url")
  @Nullable
  protected String embedUrl;

  /**
   * This URL is specifically designed for signing documents within an HTML `iframe` tag. It will be
   * returned in the response only if the `embed_url_external_user_id` parameter was passed in the
   * `create Box Sign request` call.
   */
  @JsonProperty("iframeable_embed_url")
  @Nullable
  protected String iframeableEmbedUrl;

  /** Attachments that the signer uploaded. */
  @Nullable protected List<SignRequestSignerAttachment> attachments;

  public SignRequestSigner() {
    super();
  }

  protected SignRequestSigner(Builder builder) {
    super(builder);
    this.hasViewedDocument = builder.hasViewedDocument;
    this.signerDecision = builder.signerDecision;
    this.inputs = builder.inputs;
    this.embedUrl = builder.embedUrl;
    this.iframeableEmbedUrl = builder.iframeableEmbedUrl;
    this.attachments = builder.attachments;
    markNullableFieldsAsSet(builder.getExplicitlySetNullableFields());
  }

  public Boolean getHasViewedDocument() {
    return hasViewedDocument;
  }

  public SignRequestSignerSignerDecisionField getSignerDecision() {
    return signerDecision;
  }

  public List<SignRequestSignerInput> getInputs() {
    return inputs;
  }

  public String getEmbedUrl() {
    return embedUrl;
  }

  public String getIframeableEmbedUrl() {
    return iframeableEmbedUrl;
  }

  public List<SignRequestSignerAttachment> getAttachments() {
    return attachments;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    SignRequestSigner casted = (SignRequestSigner) o;
    return Objects.equals(email, casted.email)
        && Objects.equals(role, casted.role)
        && Objects.equals(isInPerson, casted.isInPerson)
        && Objects.equals(order, casted.order)
        && Objects.equals(embedUrlExternalUserId, casted.embedUrlExternalUserId)
        && Objects.equals(redirectUrl, casted.redirectUrl)
        && Objects.equals(declinedRedirectUrl, casted.declinedRedirectUrl)
        && Objects.equals(loginRequired, casted.loginRequired)
        && Objects.equals(verificationPhoneNumber, casted.verificationPhoneNumber)
        && Objects.equals(password, casted.password)
        && Objects.equals(signerGroupId, casted.signerGroupId)
        && Objects.equals(suppressNotifications, casted.suppressNotifications)
        && Objects.equals(hasViewedDocument, casted.hasViewedDocument)
        && Objects.equals(signerDecision, casted.signerDecision)
        && Objects.equals(inputs, casted.inputs)
        && Objects.equals(embedUrl, casted.embedUrl)
        && Objects.equals(iframeableEmbedUrl, casted.iframeableEmbedUrl)
        && Objects.equals(attachments, casted.attachments);
  }

  @Override
  public int hashCode() {
    return Objects.hash(
        email,
        role,
        isInPerson,
        order,
        embedUrlExternalUserId,
        redirectUrl,
        declinedRedirectUrl,
        loginRequired,
        verificationPhoneNumber,
        password,
        signerGroupId,
        suppressNotifications,
        hasViewedDocument,
        signerDecision,
        inputs,
        embedUrl,
        iframeableEmbedUrl,
        attachments);
  }

  @Override
  public String toString() {
    return "SignRequestSigner{"
        + "email='"
        + email
        + '\''
        + ", "
        + "role='"
        + role
        + '\''
        + ", "
        + "isInPerson='"
        + isInPerson
        + '\''
        + ", "
        + "order='"
        + order
        + '\''
        + ", "
        + "embedUrlExternalUserId='"
        + embedUrlExternalUserId
        + '\''
        + ", "
        + "redirectUrl='"
        + redirectUrl
        + '\''
        + ", "
        + "declinedRedirectUrl='"
        + declinedRedirectUrl
        + '\''
        + ", "
        + "loginRequired='"
        + loginRequired
        + '\''
        + ", "
        + "verificationPhoneNumber='"
        + verificationPhoneNumber
        + '\''
        + ", "
        + "password='"
        + password
        + '\''
        + ", "
        + "signerGroupId='"
        + signerGroupId
        + '\''
        + ", "
        + "suppressNotifications='"
        + suppressNotifications
        + '\''
        + ", "
        + "hasViewedDocument='"
        + hasViewedDocument
        + '\''
        + ", "
        + "signerDecision='"
        + signerDecision
        + '\''
        + ", "
        + "inputs='"
        + inputs
        + '\''
        + ", "
        + "embedUrl='"
        + embedUrl
        + '\''
        + ", "
        + "iframeableEmbedUrl='"
        + iframeableEmbedUrl
        + '\''
        + ", "
        + "attachments='"
        + attachments
        + '\''
        + "}";
  }

  public static class Builder extends SignRequestCreateSigner.Builder {

    protected Boolean hasViewedDocument;

    protected SignRequestSignerSignerDecisionField signerDecision;

    protected List<SignRequestSignerInput> inputs;

    protected String embedUrl;

    protected String iframeableEmbedUrl;

    protected List<SignRequestSignerAttachment> attachments;

    public Builder hasViewedDocument(Boolean hasViewedDocument) {
      this.hasViewedDocument = hasViewedDocument;
      return this;
    }

    public Builder signerDecision(SignRequestSignerSignerDecisionField signerDecision) {
      this.signerDecision = signerDecision;
      this.markNullableFieldAsSet("signer_decision");
      return this;
    }

    public Builder inputs(List<SignRequestSignerInput> inputs) {
      this.inputs = inputs;
      return this;
    }

    public Builder embedUrl(String embedUrl) {
      this.embedUrl = embedUrl;
      this.markNullableFieldAsSet("embed_url");
      return this;
    }

    public Builder iframeableEmbedUrl(String iframeableEmbedUrl) {
      this.iframeableEmbedUrl = iframeableEmbedUrl;
      this.markNullableFieldAsSet("iframeable_embed_url");
      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;
      this.markNullableFieldAsSet("email");
      return this;
    }

    @Override
    public Builder role(SignRequestCreateSignerRoleField role) {
      this.role = new EnumWrapper<SignRequestCreateSignerRoleField>(role);
      return this;
    }

    @Override
    public Builder role(EnumWrapper<SignRequestCreateSignerRoleField> role) {
      this.role = role;
      return this;
    }

    @Override
    public Builder isInPerson(Boolean isInPerson) {
      this.isInPerson = isInPerson;
      return this;
    }

    @Override
    public Builder order(Long order) {
      this.order = order;
      return this;
    }

    @Override
    public Builder embedUrlExternalUserId(String embedUrlExternalUserId) {
      this.embedUrlExternalUserId = embedUrlExternalUserId;
      this.markNullableFieldAsSet("embed_url_external_user_id");
      return this;
    }

    @Override
    public Builder redirectUrl(String redirectUrl) {
      this.redirectUrl = redirectUrl;
      this.markNullableFieldAsSet("redirect_url");
      return this;
    }

    @Override
    public Builder declinedRedirectUrl(String declinedRedirectUrl) {
      this.declinedRedirectUrl = declinedRedirectUrl;
      this.markNullableFieldAsSet("declined_redirect_url");
      return this;
    }

    @Override
    public Builder loginRequired(Boolean loginRequired) {
      this.loginRequired = loginRequired;
      this.markNullableFieldAsSet("login_required");
      return this;
    }

    @Override
    public Builder verificationPhoneNumber(String verificationPhoneNumber) {
      this.verificationPhoneNumber = verificationPhoneNumber;
      this.markNullableFieldAsSet("verification_phone_number");
      return this;
    }

    @Override
    public Builder password(String password) {
      this.password = password;
      this.markNullableFieldAsSet("password");
      return this;
    }

    @Override
    public Builder signerGroupId(String signerGroupId) {
      this.signerGroupId = signerGroupId;
      this.markNullableFieldAsSet("signer_group_id");
      return this;
    }

    @Override
    public Builder suppressNotifications(Boolean suppressNotifications) {
      this.suppressNotifications = suppressNotifications;
      this.markNullableFieldAsSet("suppress_notifications");
      return this;
    }

    public SignRequestSigner build() {
      return new SignRequestSigner(this);
    }
  }
}

1	package com.box.sdkgen.schemas.signrequestsigner;
2
3	import com.box.sdkgen.internal.Nullable;
4	import com.box.sdkgen.schemas.signrequestcreatesigner.SignRequestCreateSigner;
5	import com.box.sdkgen.schemas.signrequestcreatesigner.SignRequestCreateSignerRoleField;
6	import com.box.sdkgen.schemas.signrequestsignerattachment.SignRequestSignerAttachment;
7	import com.box.sdkgen.schemas.signrequestsignerinput.SignRequestSignerInput;
8	import com.box.sdkgen.serialization.json.EnumWrapper;
9	import com.fasterxml.jackson.annotation.JsonFilter;
10	import com.fasterxml.jackson.annotation.JsonProperty;
11	import java.util.List;
12	import java.util.Objects;
13
14	/** The schema for a Signer object used on the body of a Box Sign request object. */
15	@JsonFilter("nullablePropertyFilter")
16	public class SignRequestSigner extends SignRequestCreateSigner {
17
18	/** Set to `true` if the signer views the document. */
19	@JsonProperty("has_viewed_document")
20	protected Boolean hasViewedDocument;
21
22	/** Final decision made by the signer. */
23	@JsonProperty("signer_decision")
24	@Nullable
25	protected SignRequestSignerSignerDecisionField signerDecision;
26
27	protected List<SignRequestSignerInput> inputs;
28
29	/** URL to direct a signer to for signing. */
30	@JsonProperty("embed_url")
31	@Nullable
32	protected String embedUrl;
33
34	/**
35	* This URL is specifically designed for signing documents within an HTML `iframe` tag. It will be
36	* returned in the response only if the `embed_url_external_user_id` parameter was passed in the
37	* `create Box Sign request` call.
38	*/
39	@JsonProperty("iframeable_embed_url")
40	@Nullable
41	protected String iframeableEmbedUrl;
42
43	/** Attachments that the signer uploaded. */
44	@Nullable protected List<SignRequestSignerAttachment> attachments;
45
46	public SignRequestSigner() {
47	super();	×
48	}	×
49
50	protected SignRequestSigner(Builder builder) {
51	super(builder);	×
52	this.hasViewedDocument = builder.hasViewedDocument;	×
53	this.signerDecision = builder.signerDecision;	×
54	this.inputs = builder.inputs;	×
55	this.embedUrl = builder.embedUrl;	×
56	this.iframeableEmbedUrl = builder.iframeableEmbedUrl;	×
NEW 57	this.attachments = builder.attachments;	×
58	markNullableFieldsAsSet(builder.getExplicitlySetNullableFields());	×
59	}	×
60
61	public Boolean getHasViewedDocument() {
62	return hasViewedDocument;	×
63	}
64
65	public SignRequestSignerSignerDecisionField getSignerDecision() {
66	return signerDecision;	×
67	}
68
69	public List<SignRequestSignerInput> getInputs() {
70	return inputs;	×
71	}
72
73	public String getEmbedUrl() {
74	return embedUrl;	×
75	}
76
77	public String getIframeableEmbedUrl() {
78	return iframeableEmbedUrl;	×
79	}
80
81	public List<SignRequestSignerAttachment> getAttachments() {
NEW 82	return attachments;	×
83	}
84
85	@Override
86	public boolean equals(Object o) {
87	if (this == o) {	×
88	return true;	×
89	}
90	if (o == null \|\| getClass() != o.getClass()) {	×
91	return false;	×
92	}
93	SignRequestSigner casted = (SignRequestSigner) o;	×
94	return Objects.equals(email, casted.email)	×
95	&& Objects.equals(role, casted.role)	×
96	&& Objects.equals(isInPerson, casted.isInPerson)	×
97	&& Objects.equals(order, casted.order)	×
98	&& Objects.equals(embedUrlExternalUserId, casted.embedUrlExternalUserId)	×
99	&& Objects.equals(redirectUrl, casted.redirectUrl)	×
100	&& Objects.equals(declinedRedirectUrl, casted.declinedRedirectUrl)	×
101	&& Objects.equals(loginRequired, casted.loginRequired)	×
102	&& Objects.equals(verificationPhoneNumber, casted.verificationPhoneNumber)	×
103	&& Objects.equals(password, casted.password)	×
104	&& Objects.equals(signerGroupId, casted.signerGroupId)	×
105	&& Objects.equals(suppressNotifications, casted.suppressNotifications)	×
106	&& Objects.equals(hasViewedDocument, casted.hasViewedDocument)	×
107	&& Objects.equals(signerDecision, casted.signerDecision)	×
108	&& Objects.equals(inputs, casted.inputs)	×
109	&& Objects.equals(embedUrl, casted.embedUrl)	×
NEW 110	&& Objects.equals(iframeableEmbedUrl, casted.iframeableEmbedUrl)	×
NEW 111	&& Objects.equals(attachments, casted.attachments);	×
112	}
113
114	@Override
115	public int hashCode() {
116	return Objects.hash(	×
117	email,
118	role,
119	isInPerson,
120	order,
121	embedUrlExternalUserId,
122	redirectUrl,
123	declinedRedirectUrl,
124	loginRequired,
125	verificationPhoneNumber,
126	password,
127	signerGroupId,
128	suppressNotifications,
129	hasViewedDocument,
130	signerDecision,
131	inputs,
132	embedUrl,
133	iframeableEmbedUrl,
134	attachments);
135	}
136
137	@Override
138	public String toString() {
139	return "SignRequestSigner{"	×
140	+ "email='"
141	+ email
142	+ '\''
143	+ ", "
144	+ "role='"
145	+ role
146	+ '\''
147	+ ", "
148	+ "isInPerson='"
149	+ isInPerson
150	+ '\''
151	+ ", "
152	+ "order='"
153	+ order
154	+ '\''
155	+ ", "
156	+ "embedUrlExternalUserId='"
157	+ embedUrlExternalUserId
158	+ '\''
159	+ ", "
160	+ "redirectUrl='"
161	+ redirectUrl
162	+ '\''
163	+ ", "
164	+ "declinedRedirectUrl='"
165	+ declinedRedirectUrl
166	+ '\''
167	+ ", "
168	+ "loginRequired='"
169	+ loginRequired
170	+ '\''
171	+ ", "
172	+ "verificationPhoneNumber='"
173	+ verificationPhoneNumber
174	+ '\''
175	+ ", "
176	+ "password='"
177	+ password
178	+ '\''
179	+ ", "
180	+ "signerGroupId='"
181	+ signerGroupId
182	+ '\''
183	+ ", "
184	+ "suppressNotifications='"
185	+ suppressNotifications
186	+ '\''
187	+ ", "
188	+ "hasViewedDocument='"
189	+ hasViewedDocument
190	+ '\''
191	+ ", "
192	+ "signerDecision='"
193	+ signerDecision
194	+ '\''
195	+ ", "
196	+ "inputs='"
197	+ inputs
198	+ '\''
199	+ ", "
200	+ "embedUrl='"
201	+ embedUrl
202	+ '\''
203	+ ", "
204	+ "iframeableEmbedUrl='"
205	+ iframeableEmbedUrl
206	+ '\''
207	+ ", "
208	+ "attachments='"
209	+ attachments
210	+ '\''
211	+ "}";
212	}
213
214	public static class Builder extends SignRequestCreateSigner.Builder {	×
215
216	protected Boolean hasViewedDocument;
217
218	protected SignRequestSignerSignerDecisionField signerDecision;
219
220	protected List<SignRequestSignerInput> inputs;
221
222	protected String embedUrl;
223
224	protected String iframeableEmbedUrl;
225
226	protected List<SignRequestSignerAttachment> attachments;
227
228	public Builder hasViewedDocument(Boolean hasViewedDocument) {
229	this.hasViewedDocument = hasViewedDocument;	×
230	return this;	×
231	}
232
233	public Builder signerDecision(SignRequestSignerSignerDecisionField signerDecision) {
234	this.signerDecision = signerDecision;	×
235	this.markNullableFieldAsSet("signer_decision");	×
236	return this;	×
237	}
238
239	public Builder inputs(List<SignRequestSignerInput> inputs) {
240	this.inputs = inputs;	×
241	return this;	×
242	}
243
244	public Builder embedUrl(String embedUrl) {
245	this.embedUrl = embedUrl;	×
246	this.markNullableFieldAsSet("embed_url");	×
247	return this;	×
248	}
249
250	public Builder iframeableEmbedUrl(String iframeableEmbedUrl) {
251	this.iframeableEmbedUrl = iframeableEmbedUrl;	×
252	this.markNullableFieldAsSet("iframeable_embed_url");	×
253	return this;	×
254	}
255
256	public Builder attachments(List<SignRequestSignerAttachment> attachments) {
NEW 257	this.attachments = attachments;	×
NEW 258	this.markNullableFieldAsSet("attachments");	×
NEW 259	return this;	×
260	}
261
262	@Override
263	public Builder email(String email) {
264	this.email = email;	×
265	this.markNullableFieldAsSet("email");	×
266	return this;	×
267	}
268
269	@Override
270	public Builder role(SignRequestCreateSignerRoleField role) {
271	this.role = new EnumWrapper<SignRequestCreateSignerRoleField>(role);	×
272	return this;	×
273	}
274
275	@Override
276	public Builder role(EnumWrapper<SignRequestCreateSignerRoleField> role) {
277	this.role = role;	×
278	return this;	×
279	}
280
281	@Override
282	public Builder isInPerson(Boolean isInPerson) {
283	this.isInPerson = isInPerson;	×
284	return this;	×
285	}
286
287	@Override
288	public Builder order(Long order) {
289	this.order = order;	×
290	return this;	×
291	}
292
293	@Override
294	public Builder embedUrlExternalUserId(String embedUrlExternalUserId) {
295	this.embedUrlExternalUserId = embedUrlExternalUserId;	×
296	this.markNullableFieldAsSet("embed_url_external_user_id");	×
297	return this;	×
298	}
299
300	@Override
301	public Builder redirectUrl(String redirectUrl) {
302	this.redirectUrl = redirectUrl;	×
303	this.markNullableFieldAsSet("redirect_url");	×
304	return this;	×
305	}
306
307	@Override
308	public Builder declinedRedirectUrl(String declinedRedirectUrl) {
309	this.declinedRedirectUrl = declinedRedirectUrl;	×
310	this.markNullableFieldAsSet("declined_redirect_url");	×
311	return this;	×
312	}
313
314	@Override
315	public Builder loginRequired(Boolean loginRequired) {
316	this.loginRequired = loginRequired;	×
317	this.markNullableFieldAsSet("login_required");	×
318	return this;	×
319	}
320
321	@Override
322	public Builder verificationPhoneNumber(String verificationPhoneNumber) {
323	this.verificationPhoneNumber = verificationPhoneNumber;	×
324	this.markNullableFieldAsSet("verification_phone_number");	×
325	return this;	×
326	}
327
328	@Override
329	public Builder password(String password) {
330	this.password = password;	×
331	this.markNullableFieldAsSet("password");	×
332	return this;	×
333	}
334
335	@Override
336	public Builder signerGroupId(String signerGroupId) {
337	this.signerGroupId = signerGroupId;	×
338	this.markNullableFieldAsSet("signer_group_id");	×
339	return this;	×
340	}
341
342	@Override
343	public Builder suppressNotifications(Boolean suppressNotifications) {
344	this.suppressNotifications = suppressNotifications;	×
345	this.markNullableFieldAsSet("suppress_notifications");	×
346	return this;	×
347	}
348
349	public SignRequestSigner build() {
350	return new SignRequestSigner(this);	×
351	}
352	}
353	}

box / box-java-sdk / #5762

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous