#6259

Committed 11 Feb 2026 10:35AM UTC coverage: 12.826% (-0.008%) from 12.834%

Build # #6259

Build Type

push

github

Committed by

web-flow

Commit Message

feat(boxsdkgen): add signer language, cancel sign request reason (box/box-openapi#584) (#1720)

Run Details

0 of 35 new or added lines in 4 files covered. (0.0%)

197 existing lines in 14 files now uncovered.

8368 of 65244 relevant lines covered (12.83%)

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(language, casted.language)
        && 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,
        language,
        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
        + '\''
        + ", "
        + "language='"
        + language
        + '\''
        + ", "
        + "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;
    }

    @Override
    public Builder language(String language) {
      this.language = language;
      this.markNullableFieldAsSet("language");
      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;	×
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() {
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)	×
NEW 106	&& Objects.equals(language, casted.language)	×
107	&& Objects.equals(hasViewedDocument, casted.hasViewedDocument)	×
108	&& Objects.equals(signerDecision, casted.signerDecision)	×
109	&& Objects.equals(inputs, casted.inputs)	×
110	&& Objects.equals(embedUrl, casted.embedUrl)	×
111	&& Objects.equals(iframeableEmbedUrl, casted.iframeableEmbedUrl)	×
112	&& Objects.equals(attachments, casted.attachments);	×
113	}
114
115	@Override
116	public int hashCode() {
UNCOV 117	return Objects.hash(	×
118	email,
119	role,
120	isInPerson,
121	order,
122	embedUrlExternalUserId,
123	redirectUrl,
124	declinedRedirectUrl,
125	loginRequired,
126	verificationPhoneNumber,
127	password,
128	signerGroupId,
129	suppressNotifications,
130	language,
131	hasViewedDocument,
132	signerDecision,
133	inputs,
134	embedUrl,
135	iframeableEmbedUrl,
136	attachments);
137	}
138
139	@Override
140	public String toString() {
UNCOV 141	return "SignRequestSigner{"	×
142	+ "email='"
143	+ email
144	+ '\''
145	+ ", "
146	+ "role='"
147	+ role
148	+ '\''
149	+ ", "
150	+ "isInPerson='"
151	+ isInPerson
152	+ '\''
153	+ ", "
154	+ "order='"
155	+ order
156	+ '\''
157	+ ", "
158	+ "embedUrlExternalUserId='"
159	+ embedUrlExternalUserId
160	+ '\''
161	+ ", "
162	+ "redirectUrl='"
163	+ redirectUrl
164	+ '\''
165	+ ", "
166	+ "declinedRedirectUrl='"
167	+ declinedRedirectUrl
168	+ '\''
169	+ ", "
170	+ "loginRequired='"
171	+ loginRequired
172	+ '\''
173	+ ", "
174	+ "verificationPhoneNumber='"
175	+ verificationPhoneNumber
176	+ '\''
177	+ ", "
178	+ "password='"
179	+ password
180	+ '\''
181	+ ", "
182	+ "signerGroupId='"
183	+ signerGroupId
184	+ '\''
185	+ ", "
186	+ "suppressNotifications='"
187	+ suppressNotifications
188	+ '\''
189	+ ", "
190	+ "language='"
191	+ language
192	+ '\''
193	+ ", "
194	+ "hasViewedDocument='"
195	+ hasViewedDocument
196	+ '\''
197	+ ", "
198	+ "signerDecision='"
199	+ signerDecision
200	+ '\''
201	+ ", "
202	+ "inputs='"
203	+ inputs
204	+ '\''
205	+ ", "
206	+ "embedUrl='"
207	+ embedUrl
208	+ '\''
209	+ ", "
210	+ "iframeableEmbedUrl='"
211	+ iframeableEmbedUrl
212	+ '\''
213	+ ", "
214	+ "attachments='"
215	+ attachments
216	+ '\''
217	+ "}";
218	}
219
UNCOV 220	public static class Builder extends SignRequestCreateSigner.Builder {	×
221
222	protected Boolean hasViewedDocument;
223
224	protected SignRequestSignerSignerDecisionField signerDecision;
225
226	protected List<SignRequestSignerInput> inputs;
227
228	protected String embedUrl;
229
230	protected String iframeableEmbedUrl;
231
232	protected List<SignRequestSignerAttachment> attachments;
233
234	public Builder hasViewedDocument(Boolean hasViewedDocument) {
UNCOV 235	this.hasViewedDocument = hasViewedDocument;	×
UNCOV 236	return this;	×
237	}
238
239	public Builder signerDecision(SignRequestSignerSignerDecisionField signerDecision) {
UNCOV 240	this.signerDecision = signerDecision;	×
241	this.markNullableFieldAsSet("signer_decision");	×
242	return this;	×
243	}
244
245	public Builder inputs(List<SignRequestSignerInput> inputs) {
246	this.inputs = inputs;	×
247	return this;	×
248	}
249
250	public Builder embedUrl(String embedUrl) {
UNCOV 251	this.embedUrl = embedUrl;	×
252	this.markNullableFieldAsSet("embed_url");	×
253	return this;	×
254	}
255
256	public Builder iframeableEmbedUrl(String iframeableEmbedUrl) {
257	this.iframeableEmbedUrl = iframeableEmbedUrl;	×
258	this.markNullableFieldAsSet("iframeable_embed_url");	×
259	return this;	×
260	}
261
262	public Builder attachments(List<SignRequestSignerAttachment> attachments) {
263	this.attachments = attachments;	×
264	this.markNullableFieldAsSet("attachments");	×
265	return this;	×
266	}
267
268	@Override
269	public Builder email(String email) {
270	this.email = email;	×
271	this.markNullableFieldAsSet("email");	×
UNCOV 272	return this;	×
273	}
274
275	@Override
276	public Builder role(SignRequestCreateSignerRoleField role) {
277	this.role = new EnumWrapper<SignRequestCreateSignerRoleField>(role);	×
278	return this;	×
279	}
280
281	@Override
282	public Builder role(EnumWrapper<SignRequestCreateSignerRoleField> role) {
283	this.role = role;	×
284	return this;	×
285	}
286
287	@Override
288	public Builder isInPerson(Boolean isInPerson) {
289	this.isInPerson = isInPerson;	×
290	return this;	×
291	}
292
293	@Override
294	public Builder order(Long order) {
295	this.order = order;	×
296	return this;	×
297	}
298
299	@Override
300	public Builder embedUrlExternalUserId(String embedUrlExternalUserId) {
301	this.embedUrlExternalUserId = embedUrlExternalUserId;	×
302	this.markNullableFieldAsSet("embed_url_external_user_id");	×
UNCOV 303	return this;	×
304	}
305
306	@Override
307	public Builder redirectUrl(String redirectUrl) {
308	this.redirectUrl = redirectUrl;	×
309	this.markNullableFieldAsSet("redirect_url");	×
UNCOV 310	return this;	×
311	}
312
313	@Override
314	public Builder declinedRedirectUrl(String declinedRedirectUrl) {
315	this.declinedRedirectUrl = declinedRedirectUrl;	×
316	this.markNullableFieldAsSet("declined_redirect_url");	×
UNCOV 317	return this;	×
318	}
319
320	@Override
321	public Builder loginRequired(Boolean loginRequired) {
322	this.loginRequired = loginRequired;	×
323	this.markNullableFieldAsSet("login_required");	×
UNCOV 324	return this;	×
325	}
326
327	@Override
328	public Builder verificationPhoneNumber(String verificationPhoneNumber) {
329	this.verificationPhoneNumber = verificationPhoneNumber;	×
330	this.markNullableFieldAsSet("verification_phone_number");	×
UNCOV 331	return this;	×
332	}
333
334	@Override
335	public Builder password(String password) {
336	this.password = password;	×
337	this.markNullableFieldAsSet("password");	×
UNCOV 338	return this;	×
339	}
340
341	@Override
342	public Builder signerGroupId(String signerGroupId) {
343	this.signerGroupId = signerGroupId;	×
344	this.markNullableFieldAsSet("signer_group_id");	×
UNCOV 345	return this;	×
346	}
347
348	@Override
349	public Builder suppressNotifications(Boolean suppressNotifications) {
350	this.suppressNotifications = suppressNotifications;	×
351	this.markNullableFieldAsSet("suppress_notifications");	×
UNCOV 352	return this;	×
353	}
354
355	@Override
356	public Builder language(String language) {
NEW 357	this.language = language;	×
NEW 358	this.markNullableFieldAsSet("language");	×
NEW 359	return this;	×
360	}
361
362	public SignRequestSigner build() {
363	return new SignRequestSigner(this);	×
364	}
365	}
366	}

box / box-java-sdk / #6259

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