diff --git a/CHANGELOG.md b/CHANGELOG.md
index c85565e..73d4d1e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## [v2.1.0] - WebForms API v1.1.0-1.0.6 - 2025-09-09
+### Changed
+- Added support for version v1.1.0-1.0.6 of the DocuSign WebForms API.
+- Updated the SDK release version.
+
## [v2.0.0] - WebForms API v1.1.0-1.0.4 - 2024-11-20
### Changed
- Added support for version v1.1.0-1.0.4 of the DocuSign WebForms API.
diff --git a/README.md b/README.md
index 6faf526..356e0bc 100644
--- a/README.md
+++ b/README.md
@@ -57,7 +57,7 @@ This client SDK is provided as open source, which enables you to customize its f
com.docusign
docusign-webforms-java
- 2.0.0
+ 2.1.0
```
8. If your project is still open, restart Eclipse.
diff --git a/pom.xml b/pom.xml
index 5bf7e37..c9d3efa 100644
--- a/pom.xml
+++ b/pom.xml
@@ -5,7 +5,7 @@
docusign-webforms-java
jar
docusign-webforms-java
- 2.0.0
+ 2.1.0
https://developers.docusign.com
The Docusign NuGet package makes integrating Docusign into your apps and websites a super fast and painless process. The library is open sourced on GitHub, look for the docusign-webforms-csharp-client repository.
@@ -15,12 +15,12 @@
- ossrh
- https://s01.oss.sonatype.org/content/repositories/snapshots
+ central
+ https://central.sonatype.com/repository/maven-snapshots/
- ossrh2
- https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/
+ central
+ https://central.sonatype.com/repository/maven-releases/
@@ -230,7 +230,7 @@
org.owasp
dependency-check-maven
- 10.0.2
+ 12.1.1
8
@@ -309,13 +309,13 @@
- org.sonatype.plugins
- nexus-staging-maven-plugin
- 1.6.8
+ org.sonatype.central
+ central-publishing-maven-plugin
+ 0.8.0
+ true
- ossrh
- https://s01.oss.sonatype.org/
- true
+ central
+ true
diff --git a/src/main/java/com/docusign/webforms/client/ApiClient.java b/src/main/java/com/docusign/webforms/client/ApiClient.java
index 6bc949a..93c8719 100644
--- a/src/main/java/com/docusign/webforms/client/ApiClient.java
+++ b/src/main/java/com/docusign/webforms/client/ApiClient.java
@@ -93,7 +93,7 @@ public ApiClient() {
String javaVersion = System.getProperty("java.version");
// Set default User-Agent.
- setUserAgent("Swagger-Codegen/1.1.0/2.0.0/Java/" + javaVersion);
+ setUserAgent("Swagger-Codegen/1.1.0/2.1.0/Java/" + javaVersion);
// Setup authentications (key: authentication name, value: authentication).
authentications = new HashMap();
diff --git a/src/main/java/com/docusign/webforms/model/CreateInstanceRequestBody.java b/src/main/java/com/docusign/webforms/model/CreateInstanceRequestBody.java
index bbe3bad..7dace18 100644
--- a/src/main/java/com/docusign/webforms/model/CreateInstanceRequestBody.java
+++ b/src/main/java/com/docusign/webforms/model/CreateInstanceRequestBody.java
@@ -3,7 +3,8 @@
import java.util.Objects;
import java.util.Arrays;
import com.docusign.webforms.model.AuthenticationMethod;
-import com.docusign.webforms.model.WebFormValues;
+import com.docusign.webforms.model.CreateInstanceRequestBodyRecipients;
+import com.docusign.webforms.model.SendOption;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
@@ -20,7 +21,7 @@ public class CreateInstanceRequestBody implements Serializable {
private static final long serialVersionUID = 1L;
@JsonProperty("formValues")
- private WebFormValues formValues = null;
+ private java.util.Map formValues = null;
@JsonProperty("clientUserId")
private String clientUserId = null;
@@ -43,6 +44,15 @@ public class CreateInstanceRequestBody implements Serializable {
@JsonProperty("expirationOffset")
private Integer expirationOffset = null;
+ @JsonProperty("sendOption")
+ private SendOption sendOption = null;
+
+ @JsonProperty("brandId")
+ private String brandId = null;
+
+ @JsonProperty("recipients")
+ private java.util.List recipients = null;
+
@JsonProperty("tags")
private java.util.List tags = null;
@@ -52,24 +62,37 @@ public class CreateInstanceRequestBody implements Serializable {
*
* @return CreateInstanceRequestBody
**/
- public CreateInstanceRequestBody formValues(WebFormValues formValues) {
+ public CreateInstanceRequestBody formValues(java.util.Map formValues) {
this.formValues = formValues;
return this;
}
/**
- * Get formValues.
+ * putFormValuesItem.
+ *
+ * @return CreateInstanceRequestBody
+ **/
+ public CreateInstanceRequestBody putFormValuesItem(String key, Object formValuesItem) {
+ if (this.formValues == null) {
+ this.formValues = new java.util.HashMap<>();
+ }
+ this.formValues.put(key, formValuesItem);
+ return this;
+ }
+
+ /**
+ * Key-value pairs (where key is the component name and value is the form value) used to create a form instance. For key of type TextBox, Email, Date, Select and RadioButtonGroup the value is of string type. For key of type Number, the value is of number type. For key of type of CheckboxGroup, the value is of type array of string..
* @return formValues
**/
- @Schema(description = "")
- public WebFormValues getFormValues() {
+ @Schema(example = "{\"Textbox_Name\":\"First Last\",\"Email_primary\":\"example@example.com\",\"Date_birth\":\"2020-01-01\",\"Number_age\":52,\"Select_state\":\"California\",\"Radio_Gender\":\"Female\",\"Checkbox_hobbies\":[\"singing\",\"dancing\"],\"ID_card_attachment\":{\"documentName\":\"id_card.pdf\"}}", description = "Key-value pairs (where key is the component name and value is the form value) used to create a form instance. For key of type TextBox, Email, Date, Select and RadioButtonGroup the value is of string type. For key of type Number, the value is of number type. For key of type of CheckboxGroup, the value is of type array of string.")
+ public java.util.Map getFormValues() {
return formValues;
}
/**
* setFormValues.
**/
- public void setFormValues(WebFormValues formValues) {
+ public void setFormValues(java.util.Map formValues) {
this.formValues = formValues;
}
@@ -88,7 +111,7 @@ public CreateInstanceRequestBody clientUserId(String clientUserId) {
* Get clientUserId.
* @return clientUserId
**/
- @Schema(required = true, description = "")
+ @Schema(description = "")
public String getClientUserId() {
return clientUserId;
}
@@ -263,6 +286,100 @@ public void setExpirationOffset(Integer expirationOffset) {
}
+ /**
+ * sendOption.
+ *
+ * @return CreateInstanceRequestBody
+ **/
+ public CreateInstanceRequestBody sendOption(SendOption sendOption) {
+ this.sendOption = sendOption;
+ return this;
+ }
+
+ /**
+ * Get sendOption.
+ * @return sendOption
+ **/
+ @Schema(description = "")
+ public SendOption getSendOption() {
+ return sendOption;
+ }
+
+ /**
+ * setSendOption.
+ **/
+ public void setSendOption(SendOption sendOption) {
+ this.sendOption = sendOption;
+ }
+
+
+ /**
+ * brandId.
+ *
+ * @return CreateInstanceRequestBody
+ **/
+ public CreateInstanceRequestBody brandId(String brandId) {
+ this.brandId = brandId;
+ return this;
+ }
+
+ /**
+ * Get brandId.
+ * @return brandId
+ **/
+ @Schema(description = "")
+ public String getBrandId() {
+ return brandId;
+ }
+
+ /**
+ * setBrandId.
+ **/
+ public void setBrandId(String brandId) {
+ this.brandId = brandId;
+ }
+
+
+ /**
+ * recipients.
+ *
+ * @return CreateInstanceRequestBody
+ **/
+ public CreateInstanceRequestBody recipients(java.util.List recipients) {
+ this.recipients = recipients;
+ return this;
+ }
+
+ /**
+ * addRecipientsItem.
+ *
+ * @return CreateInstanceRequestBody
+ **/
+ public CreateInstanceRequestBody addRecipientsItem(CreateInstanceRequestBodyRecipients recipientsItem) {
+ if (this.recipients == null) {
+ this.recipients = new java.util.ArrayList<>();
+ }
+ this.recipients.add(recipientsItem);
+ return this;
+ }
+
+ /**
+ * The recipients who will receive the form in email.
+ * @return recipients
+ **/
+ @Schema(description = "The recipients who will receive the form in email")
+ public java.util.List getRecipients() {
+ return recipients;
+ }
+
+ /**
+ * setRecipients.
+ **/
+ public void setRecipients(java.util.List recipients) {
+ this.recipients = recipients;
+ }
+
+
/**
* tags.
*
@@ -325,6 +442,9 @@ public boolean equals(java.lang.Object o) {
Objects.equals(this.securityDomain, createInstanceRequestBody.securityDomain) &&
Objects.equals(this.returnUrl, createInstanceRequestBody.returnUrl) &&
Objects.equals(this.expirationOffset, createInstanceRequestBody.expirationOffset) &&
+ Objects.equals(this.sendOption, createInstanceRequestBody.sendOption) &&
+ Objects.equals(this.brandId, createInstanceRequestBody.brandId) &&
+ Objects.equals(this.recipients, createInstanceRequestBody.recipients) &&
Objects.equals(this.tags, createInstanceRequestBody.tags);
}
@@ -333,7 +453,7 @@ public boolean equals(java.lang.Object o) {
*/
@Override
public int hashCode() {
- return Objects.hash(formValues, clientUserId, authenticationInstant, authenticationMethod, assertionId, securityDomain, returnUrl, expirationOffset, tags);
+ return Objects.hash(formValues, clientUserId, authenticationInstant, authenticationMethod, assertionId, securityDomain, returnUrl, expirationOffset, sendOption, brandId, recipients, tags);
}
@@ -353,6 +473,9 @@ public String toString() {
sb.append(" securityDomain: ").append(toIndentedString(securityDomain)).append("\n");
sb.append(" returnUrl: ").append(toIndentedString(returnUrl)).append("\n");
sb.append(" expirationOffset: ").append(toIndentedString(expirationOffset)).append("\n");
+ sb.append(" sendOption: ").append(toIndentedString(sendOption)).append("\n");
+ sb.append(" brandId: ").append(toIndentedString(brandId)).append("\n");
+ sb.append(" recipients: ").append(toIndentedString(recipients)).append("\n");
sb.append(" tags: ").append(toIndentedString(tags)).append("\n");
sb.append("}");
return sb.toString();
diff --git a/src/main/java/com/docusign/webforms/model/CreateInstanceRequestBodyRecipients.java b/src/main/java/com/docusign/webforms/model/CreateInstanceRequestBodyRecipients.java
new file mode 100644
index 0000000..1a203dc
--- /dev/null
+++ b/src/main/java/com/docusign/webforms/model/CreateInstanceRequestBodyRecipients.java
@@ -0,0 +1,198 @@
+package com.docusign.webforms.model;
+
+import java.util.Objects;
+import java.util.Arrays;
+import com.docusign.webforms.model.PhoneNumber;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonValue;
+import io.swagger.v3.oas.annotations.media.Schema;
+import java.io.Serializable;
+
+/**
+ * CreateInstanceRequestBodyRecipients.
+ *
+ */
+
+public class CreateInstanceRequestBodyRecipients implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ @JsonProperty("roleName")
+ private String roleName = null;
+
+ @JsonProperty("name")
+ private String name = null;
+
+ @JsonProperty("email")
+ private String email = null;
+
+ @JsonProperty("phoneNumber")
+ private PhoneNumber phoneNumber = null;
+
+
+ /**
+ * roleName.
+ *
+ * @return CreateInstanceRequestBodyRecipients
+ **/
+ public CreateInstanceRequestBodyRecipients roleName(String roleName) {
+ this.roleName = roleName;
+ return this;
+ }
+
+ /**
+ * Get roleName.
+ * @return roleName
+ **/
+ @Schema(required = true, description = "")
+ public String getRoleName() {
+ return roleName;
+ }
+
+ /**
+ * setRoleName.
+ **/
+ public void setRoleName(String roleName) {
+ this.roleName = roleName;
+ }
+
+
+ /**
+ * name.
+ *
+ * @return CreateInstanceRequestBodyRecipients
+ **/
+ public CreateInstanceRequestBodyRecipients name(String name) {
+ this.name = name;
+ return this;
+ }
+
+ /**
+ * Get name.
+ * @return name
+ **/
+ @Schema(required = true, description = "")
+ public String getName() {
+ return name;
+ }
+
+ /**
+ * setName.
+ **/
+ public void setName(String name) {
+ this.name = name;
+ }
+
+
+ /**
+ * email.
+ *
+ * @return CreateInstanceRequestBodyRecipients
+ **/
+ public CreateInstanceRequestBodyRecipients email(String email) {
+ this.email = email;
+ return this;
+ }
+
+ /**
+ * Get email.
+ * @return email
+ **/
+ @Schema(required = true, description = "")
+ public String getEmail() {
+ return email;
+ }
+
+ /**
+ * setEmail.
+ **/
+ public void setEmail(String email) {
+ this.email = email;
+ }
+
+
+ /**
+ * phoneNumber.
+ *
+ * @return CreateInstanceRequestBodyRecipients
+ **/
+ public CreateInstanceRequestBodyRecipients phoneNumber(PhoneNumber phoneNumber) {
+ this.phoneNumber = phoneNumber;
+ return this;
+ }
+
+ /**
+ * Get phoneNumber.
+ * @return phoneNumber
+ **/
+ @Schema(description = "")
+ public PhoneNumber getPhoneNumber() {
+ return phoneNumber;
+ }
+
+ /**
+ * setPhoneNumber.
+ **/
+ public void setPhoneNumber(PhoneNumber phoneNumber) {
+ this.phoneNumber = phoneNumber;
+ }
+
+
+ /**
+ * Compares objects.
+ *
+ * @return true or false depending on comparison result.
+ */
+ @Override
+ public boolean equals(java.lang.Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (o == null || getClass() != o.getClass()) {
+ return false;
+ }
+ CreateInstanceRequestBodyRecipients createInstanceRequestBodyRecipients = (CreateInstanceRequestBodyRecipients) o;
+ return Objects.equals(this.roleName, createInstanceRequestBodyRecipients.roleName) &&
+ Objects.equals(this.name, createInstanceRequestBodyRecipients.name) &&
+ Objects.equals(this.email, createInstanceRequestBodyRecipients.email) &&
+ Objects.equals(this.phoneNumber, createInstanceRequestBodyRecipients.phoneNumber);
+ }
+
+ /**
+ * Returns the HashCode.
+ */
+ @Override
+ public int hashCode() {
+ return Objects.hash(roleName, name, email, phoneNumber);
+ }
+
+
+ /**
+ * Converts the given object to string.
+ */
+ @Override
+ public String toString() {
+ StringBuilder sb = new StringBuilder();
+ sb.append("class CreateInstanceRequestBodyRecipients {\n");
+
+ sb.append(" roleName: ").append(toIndentedString(roleName)).append("\n");
+ sb.append(" name: ").append(toIndentedString(name)).append("\n");
+ sb.append(" email: ").append(toIndentedString(email)).append("\n");
+ sb.append(" phoneNumber: ").append(toIndentedString(phoneNumber)).append("\n");
+ sb.append("}");
+ return sb.toString();
+ }
+
+ /**
+ * Convert the given object to string with each line indented by 4 spaces
+ * (except the first line).
+ */
+ private String toIndentedString(java.lang.Object o) {
+ if (o == null) {
+ return "null";
+ }
+ return o.toString().replace("\n", "\n ");
+ }
+
+}
+
diff --git a/src/main/java/com/docusign/webforms/model/InstanceRecipientStatus.java b/src/main/java/com/docusign/webforms/model/InstanceRecipientStatus.java
new file mode 100644
index 0000000..d04c3eb
--- /dev/null
+++ b/src/main/java/com/docusign/webforms/model/InstanceRecipientStatus.java
@@ -0,0 +1,48 @@
+package com.docusign.webforms.model;
+
+import java.util.Objects;
+import java.util.Arrays;
+import io.swagger.v3.oas.annotations.media.Schema;
+import java.io.Serializable;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonValue;
+
+/**
+ * The current status of the instance for the recipient
+ */
+public enum InstanceRecipientStatus {
+
+ INITIATED("INITIATED"),
+
+ IN_PROGRESS("IN_PROGRESS"),
+
+ SUBMITTED("SUBMITTED");
+
+ private String value;
+
+ InstanceRecipientStatus(String value) {
+ this.value = value;
+ }
+
+ @JsonValue
+ public String getValue() {
+ return value;
+ }
+
+ @Override
+ public String toString() {
+ return String.valueOf(value);
+ }
+
+ @JsonCreator
+ public static InstanceRecipientStatus fromValue(String value) {
+ for (InstanceRecipientStatus b : InstanceRecipientStatus.values()) {
+ if (b.value.equals(value)) {
+ return b;
+ }
+ }
+ return null;
+ }
+}
+
diff --git a/src/main/java/com/docusign/webforms/model/PhoneNumber.java b/src/main/java/com/docusign/webforms/model/PhoneNumber.java
new file mode 100644
index 0000000..6d1ebd6
--- /dev/null
+++ b/src/main/java/com/docusign/webforms/model/PhoneNumber.java
@@ -0,0 +1,134 @@
+package com.docusign.webforms.model;
+
+import java.util.Objects;
+import java.util.Arrays;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonValue;
+import io.swagger.v3.oas.annotations.media.Schema;
+import java.io.Serializable;
+
+/**
+ * Phone number of the user..
+ *
+ */
+@Schema(description = "Phone number of the user.")
+
+public class PhoneNumber implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ @JsonProperty("countryCode")
+ private String countryCode = null;
+
+ @JsonProperty("nationalNumber")
+ private String nationalNumber = null;
+
+
+ /**
+ * countryCode.
+ *
+ * @return PhoneNumber
+ **/
+ public PhoneNumber countryCode(String countryCode) {
+ this.countryCode = countryCode;
+ return this;
+ }
+
+ /**
+ * country code of the registered phone number..
+ * @return countryCode
+ **/
+ @Schema(example = "1", description = "country code of the registered phone number.")
+ public String getCountryCode() {
+ return countryCode;
+ }
+
+ /**
+ * setCountryCode.
+ **/
+ public void setCountryCode(String countryCode) {
+ this.countryCode = countryCode;
+ }
+
+
+ /**
+ * nationalNumber.
+ *
+ * @return PhoneNumber
+ **/
+ public PhoneNumber nationalNumber(String nationalNumber) {
+ this.nationalNumber = nationalNumber;
+ return this;
+ }
+
+ /**
+ * Phone number of the user (without country code)..
+ * @return nationalNumber
+ **/
+ @Schema(example = "4151112222", description = "Phone number of the user (without country code).")
+ public String getNationalNumber() {
+ return nationalNumber;
+ }
+
+ /**
+ * setNationalNumber.
+ **/
+ public void setNationalNumber(String nationalNumber) {
+ this.nationalNumber = nationalNumber;
+ }
+
+
+ /**
+ * Compares objects.
+ *
+ * @return true or false depending on comparison result.
+ */
+ @Override
+ public boolean equals(java.lang.Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (o == null || getClass() != o.getClass()) {
+ return false;
+ }
+ PhoneNumber phoneNumber = (PhoneNumber) o;
+ return Objects.equals(this.countryCode, phoneNumber.countryCode) &&
+ Objects.equals(this.nationalNumber, phoneNumber.nationalNumber);
+ }
+
+ /**
+ * Returns the HashCode.
+ */
+ @Override
+ public int hashCode() {
+ return Objects.hash(countryCode, nationalNumber);
+ }
+
+
+ /**
+ * Converts the given object to string.
+ */
+ @Override
+ public String toString() {
+ StringBuilder sb = new StringBuilder();
+ sb.append("class PhoneNumber {\n");
+
+ sb.append(" countryCode: ").append(toIndentedString(countryCode)).append("\n");
+ sb.append(" nationalNumber: ").append(toIndentedString(nationalNumber)).append("\n");
+ sb.append("}");
+ return sb.toString();
+ }
+
+ /**
+ * Convert the given object to string with each line indented by 4 spaces
+ * (except the first line).
+ */
+ private String toIndentedString(java.lang.Object o) {
+ if (o == null) {
+ return "null";
+ }
+ return o.toString().replace("\n", "\n ");
+ }
+
+}
+
diff --git a/src/main/java/com/docusign/webforms/model/SendOption.java b/src/main/java/com/docusign/webforms/model/SendOption.java
new file mode 100644
index 0000000..04e8137
--- /dev/null
+++ b/src/main/java/com/docusign/webforms/model/SendOption.java
@@ -0,0 +1,44 @@
+package com.docusign.webforms.model;
+
+import java.util.Objects;
+import java.util.Arrays;
+import io.swagger.v3.oas.annotations.media.Schema;
+import java.io.Serializable;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonValue;
+
+/**
+ * Specifies the delivery behavior of the web form. - `now`: The web form will be sent immediately.
+ */
+public enum SendOption {
+
+ NOW("now");
+
+ private String value;
+
+ SendOption(String value) {
+ this.value = value;
+ }
+
+ @JsonValue
+ public String getValue() {
+ return value;
+ }
+
+ @Override
+ public String toString() {
+ return String.valueOf(value);
+ }
+
+ @JsonCreator
+ public static SendOption fromValue(String value) {
+ for (SendOption b : SendOption.values()) {
+ if (b.value.equals(value)) {
+ return b;
+ }
+ }
+ return null;
+ }
+}
+
diff --git a/src/main/java/com/docusign/webforms/model/WebFormComponentType.java b/src/main/java/com/docusign/webforms/model/WebFormComponentType.java
index 6c29841..3fb6eb9 100644
--- a/src/main/java/com/docusign/webforms/model/WebFormComponentType.java
+++ b/src/main/java/com/docusign/webforms/model/WebFormComponentType.java
@@ -25,7 +25,9 @@ public enum WebFormComponentType {
SELECT("Select"),
- TEXTBOX("TextBox");
+ TEXTBOX("TextBox"),
+
+ FILEINPUT("FileInput");
private String value;
diff --git a/src/main/java/com/docusign/webforms/model/WebFormInstance.java b/src/main/java/com/docusign/webforms/model/WebFormInstance.java
index d4cd2d4..3cf5256 100644
--- a/src/main/java/com/docusign/webforms/model/WebFormInstance.java
+++ b/src/main/java/com/docusign/webforms/model/WebFormInstance.java
@@ -5,7 +5,7 @@
import com.docusign.webforms.model.InstanceStatus;
import com.docusign.webforms.model.WebFormInstanceEnvelopes;
import com.docusign.webforms.model.WebFormInstanceMetadata;
-import com.docusign.webforms.model.WebFormValues;
+import com.docusign.webforms.model.WebFormInstanceRecipients;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
@@ -55,7 +55,13 @@ public class WebFormInstance implements Serializable {
private WebFormInstanceMetadata instanceMetadata = null;
@JsonProperty("formValues")
- private WebFormValues formValues = null;
+ private java.util.Map formValues = null;
+
+ @JsonProperty("brandId")
+ private String brandId = null;
+
+ @JsonProperty("recipients")
+ private java.util.List recipients = null;
/**
@@ -386,28 +392,108 @@ public void setInstanceMetadata(WebFormInstanceMetadata instanceMetadata) {
*
* @return WebFormInstance
**/
- public WebFormInstance formValues(WebFormValues formValues) {
+ public WebFormInstance formValues(java.util.Map formValues) {
this.formValues = formValues;
return this;
}
/**
- * Get formValues.
+ * putFormValuesItem.
+ *
+ * @return WebFormInstance
+ **/
+ public WebFormInstance putFormValuesItem(String key, Object formValuesItem) {
+ if (this.formValues == null) {
+ this.formValues = new java.util.HashMap<>();
+ }
+ this.formValues.put(key, formValuesItem);
+ return this;
+ }
+
+ /**
+ * Key-value pairs (where key is the component name and value is the form value) used to create a form instance. For key of type TextBox, Email, Date, Select and RadioButtonGroup the value is of string type. For key of type Number, the value is of number type. For key of type of CheckboxGroup, the value is of type array of string..
* @return formValues
**/
- @Schema(description = "")
- public WebFormValues getFormValues() {
+ @Schema(example = "{\"Textbox_Name\":\"First Last\",\"Email_primary\":\"example@example.com\",\"Date_birth\":\"2020-01-01\",\"Number_age\":52,\"Select_state\":\"California\",\"Radio_Gender\":\"Female\",\"Checkbox_hobbies\":[\"singing\",\"dancing\"],\"ID_card_attachment\":{\"documentName\":\"id_card.pdf\"}}", description = "Key-value pairs (where key is the component name and value is the form value) used to create a form instance. For key of type TextBox, Email, Date, Select and RadioButtonGroup the value is of string type. For key of type Number, the value is of number type. For key of type of CheckboxGroup, the value is of type array of string.")
+ public java.util.Map getFormValues() {
return formValues;
}
/**
* setFormValues.
**/
- public void setFormValues(WebFormValues formValues) {
+ public void setFormValues(java.util.Map formValues) {
this.formValues = formValues;
}
+ /**
+ * brandId.
+ *
+ * @return WebFormInstance
+ **/
+ public WebFormInstance brandId(String brandId) {
+ this.brandId = brandId;
+ return this;
+ }
+
+ /**
+ * Get brandId.
+ * @return brandId
+ **/
+ @Schema(description = "")
+ public String getBrandId() {
+ return brandId;
+ }
+
+ /**
+ * setBrandId.
+ **/
+ public void setBrandId(String brandId) {
+ this.brandId = brandId;
+ }
+
+
+ /**
+ * recipients.
+ *
+ * @return WebFormInstance
+ **/
+ public WebFormInstance recipients(java.util.List recipients) {
+ this.recipients = recipients;
+ return this;
+ }
+
+ /**
+ * addRecipientsItem.
+ *
+ * @return WebFormInstance
+ **/
+ public WebFormInstance addRecipientsItem(WebFormInstanceRecipients recipientsItem) {
+ if (this.recipients == null) {
+ this.recipients = new java.util.ArrayList<>();
+ }
+ this.recipients.add(recipientsItem);
+ return this;
+ }
+
+ /**
+ * The associated envelope that is created when the instance is submitted.
+ * @return recipients
+ **/
+ @Schema(description = "The associated envelope that is created when the instance is submitted")
+ public java.util.List getRecipients() {
+ return recipients;
+ }
+
+ /**
+ * setRecipients.
+ **/
+ public void setRecipients(java.util.List recipients) {
+ this.recipients = recipients;
+ }
+
+
/**
* Compares objects.
*
@@ -433,7 +519,9 @@ public boolean equals(java.lang.Object o) {
Objects.equals(this.status, webFormInstance.status) &&
Objects.equals(this.envelopes, webFormInstance.envelopes) &&
Objects.equals(this.instanceMetadata, webFormInstance.instanceMetadata) &&
- Objects.equals(this.formValues, webFormInstance.formValues);
+ Objects.equals(this.formValues, webFormInstance.formValues) &&
+ Objects.equals(this.brandId, webFormInstance.brandId) &&
+ Objects.equals(this.recipients, webFormInstance.recipients);
}
/**
@@ -441,7 +529,7 @@ public boolean equals(java.lang.Object o) {
*/
@Override
public int hashCode() {
- return Objects.hash(formUrl, instanceToken, tokenExpirationDateTime, id, formId, accountId, clientUserId, tags, status, envelopes, instanceMetadata, formValues);
+ return Objects.hash(formUrl, instanceToken, tokenExpirationDateTime, id, formId, accountId, clientUserId, tags, status, envelopes, instanceMetadata, formValues, brandId, recipients);
}
@@ -465,6 +553,8 @@ public String toString() {
sb.append(" envelopes: ").append(toIndentedString(envelopes)).append("\n");
sb.append(" instanceMetadata: ").append(toIndentedString(instanceMetadata)).append("\n");
sb.append(" formValues: ").append(toIndentedString(formValues)).append("\n");
+ sb.append(" brandId: ").append(toIndentedString(brandId)).append("\n");
+ sb.append(" recipients: ").append(toIndentedString(recipients)).append("\n");
sb.append("}");
return sb.toString();
}
diff --git a/src/main/java/com/docusign/webforms/model/WebFormInstanceEnvelopes.java b/src/main/java/com/docusign/webforms/model/WebFormInstanceEnvelopes.java
index 90f1c8e..7760445 100644
--- a/src/main/java/com/docusign/webforms/model/WebFormInstanceEnvelopes.java
+++ b/src/main/java/com/docusign/webforms/model/WebFormInstanceEnvelopes.java
@@ -6,6 +6,7 @@
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import io.swagger.v3.oas.annotations.media.Schema;
+import java.time.OffsetDateTime;
import java.io.Serializable;
/**
@@ -19,6 +20,9 @@ public class WebFormInstanceEnvelopes implements Serializable {
@JsonProperty("id")
private String id = null;
+ @JsonProperty("createdDateTime")
+ private String createdDateTime = null;
+
/**
* id.
@@ -47,6 +51,33 @@ public void setId(String id) {
}
+ /**
+ * createdDateTime.
+ *
+ * @return WebFormInstanceEnvelopes
+ **/
+ public WebFormInstanceEnvelopes createdDateTime(String createdDateTime) {
+ this.createdDateTime = createdDateTime;
+ return this;
+ }
+
+ /**
+ * The dateTime when an envelope is created..
+ * @return createdDateTime
+ **/
+ @Schema(description = "The dateTime when an envelope is created.")
+ public String getCreatedDateTime() {
+ return createdDateTime;
+ }
+
+ /**
+ * setCreatedDateTime.
+ **/
+ public void setCreatedDateTime(String createdDateTime) {
+ this.createdDateTime = createdDateTime;
+ }
+
+
/**
* Compares objects.
*
@@ -61,7 +92,8 @@ public boolean equals(java.lang.Object o) {
return false;
}
WebFormInstanceEnvelopes webFormInstanceEnvelopes = (WebFormInstanceEnvelopes) o;
- return Objects.equals(this.id, webFormInstanceEnvelopes.id);
+ return Objects.equals(this.id, webFormInstanceEnvelopes.id) &&
+ Objects.equals(this.createdDateTime, webFormInstanceEnvelopes.createdDateTime);
}
/**
@@ -69,7 +101,7 @@ public boolean equals(java.lang.Object o) {
*/
@Override
public int hashCode() {
- return Objects.hash(id);
+ return Objects.hash(id, createdDateTime);
}
@@ -82,6 +114,7 @@ public String toString() {
sb.append("class WebFormInstanceEnvelopes {\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
+ sb.append(" createdDateTime: ").append(toIndentedString(createdDateTime)).append("\n");
sb.append("}");
return sb.toString();
}
diff --git a/src/main/java/com/docusign/webforms/model/WebFormInstanceMetadata.java b/src/main/java/com/docusign/webforms/model/WebFormInstanceMetadata.java
index 8524324..0cfecab 100644
--- a/src/main/java/com/docusign/webforms/model/WebFormInstanceMetadata.java
+++ b/src/main/java/com/docusign/webforms/model/WebFormInstanceMetadata.java
@@ -2,6 +2,7 @@
import java.util.Objects;
import java.util.Arrays;
+import com.docusign.webforms.model.InstanceSource;
import com.docusign.webforms.model.WebFormUserInfo;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
@@ -33,6 +34,12 @@ public class WebFormInstanceMetadata implements Serializable {
@JsonProperty("lastModifiedBy")
private WebFormUserInfo lastModifiedBy = null;
+ @JsonProperty("submittedDateTime")
+ private String submittedDateTime = null;
+
+ @JsonProperty("instanceSource")
+ private InstanceSource instanceSource = null;
+
/**
* expirationDateTime.
@@ -169,6 +176,60 @@ public void setLastModifiedBy(WebFormUserInfo lastModifiedBy) {
}
+ /**
+ * submittedDateTime.
+ *
+ * @return WebFormInstanceMetadata
+ **/
+ public WebFormInstanceMetadata submittedDateTime(String submittedDateTime) {
+ this.submittedDateTime = submittedDateTime;
+ return this;
+ }
+
+ /**
+ * Get submittedDateTime.
+ * @return submittedDateTime
+ **/
+ @Schema(description = "")
+ public String getSubmittedDateTime() {
+ return submittedDateTime;
+ }
+
+ /**
+ * setSubmittedDateTime.
+ **/
+ public void setSubmittedDateTime(String submittedDateTime) {
+ this.submittedDateTime = submittedDateTime;
+ }
+
+
+ /**
+ * instanceSource.
+ *
+ * @return WebFormInstanceMetadata
+ **/
+ public WebFormInstanceMetadata instanceSource(InstanceSource instanceSource) {
+ this.instanceSource = instanceSource;
+ return this;
+ }
+
+ /**
+ * Get instanceSource.
+ * @return instanceSource
+ **/
+ @Schema(description = "")
+ public InstanceSource getInstanceSource() {
+ return instanceSource;
+ }
+
+ /**
+ * setInstanceSource.
+ **/
+ public void setInstanceSource(InstanceSource instanceSource) {
+ this.instanceSource = instanceSource;
+ }
+
+
/**
* Compares objects.
*
@@ -187,7 +248,9 @@ public boolean equals(java.lang.Object o) {
Objects.equals(this.createdDateTime, webFormInstanceMetadata.createdDateTime) &&
Objects.equals(this.createdBy, webFormInstanceMetadata.createdBy) &&
Objects.equals(this.lastModifiedDateTime, webFormInstanceMetadata.lastModifiedDateTime) &&
- Objects.equals(this.lastModifiedBy, webFormInstanceMetadata.lastModifiedBy);
+ Objects.equals(this.lastModifiedBy, webFormInstanceMetadata.lastModifiedBy) &&
+ Objects.equals(this.submittedDateTime, webFormInstanceMetadata.submittedDateTime) &&
+ Objects.equals(this.instanceSource, webFormInstanceMetadata.instanceSource);
}
/**
@@ -195,7 +258,7 @@ public boolean equals(java.lang.Object o) {
*/
@Override
public int hashCode() {
- return Objects.hash(expirationDateTime, createdDateTime, createdBy, lastModifiedDateTime, lastModifiedBy);
+ return Objects.hash(expirationDateTime, createdDateTime, createdBy, lastModifiedDateTime, lastModifiedBy, submittedDateTime, instanceSource);
}
@@ -212,6 +275,8 @@ public String toString() {
sb.append(" createdBy: ").append(toIndentedString(createdBy)).append("\n");
sb.append(" lastModifiedDateTime: ").append(toIndentedString(lastModifiedDateTime)).append("\n");
sb.append(" lastModifiedBy: ").append(toIndentedString(lastModifiedBy)).append("\n");
+ sb.append(" submittedDateTime: ").append(toIndentedString(submittedDateTime)).append("\n");
+ sb.append(" instanceSource: ").append(toIndentedString(instanceSource)).append("\n");
sb.append("}");
return sb.toString();
}
diff --git a/src/main/java/com/docusign/webforms/model/WebFormInstanceRecipients.java b/src/main/java/com/docusign/webforms/model/WebFormInstanceRecipients.java
new file mode 100644
index 0000000..c68164d
--- /dev/null
+++ b/src/main/java/com/docusign/webforms/model/WebFormInstanceRecipients.java
@@ -0,0 +1,166 @@
+package com.docusign.webforms.model;
+
+import java.util.Objects;
+import java.util.Arrays;
+import com.docusign.webforms.model.InstanceRecipientStatus;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonValue;
+import io.swagger.v3.oas.annotations.media.Schema;
+import java.io.Serializable;
+
+/**
+ * WebFormInstanceRecipients.
+ *
+ */
+
+public class WebFormInstanceRecipients implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ @JsonProperty("recipientViewId")
+ private String recipientViewId = null;
+
+ @JsonProperty("instanceRecipientStatus")
+ private InstanceRecipientStatus instanceRecipientStatus = null;
+
+ @JsonProperty("roleName")
+ private String roleName = null;
+
+
+ /**
+ * recipientViewId.
+ *
+ * @return WebFormInstanceRecipients
+ **/
+ public WebFormInstanceRecipients recipientViewId(String recipientViewId) {
+ this.recipientViewId = recipientViewId;
+ return this;
+ }
+
+ /**
+ * Get recipientViewId.
+ * @return recipientViewId
+ **/
+ @Schema(description = "")
+ public String getRecipientViewId() {
+ return recipientViewId;
+ }
+
+ /**
+ * setRecipientViewId.
+ **/
+ public void setRecipientViewId(String recipientViewId) {
+ this.recipientViewId = recipientViewId;
+ }
+
+
+ /**
+ * instanceRecipientStatus.
+ *
+ * @return WebFormInstanceRecipients
+ **/
+ public WebFormInstanceRecipients instanceRecipientStatus(InstanceRecipientStatus instanceRecipientStatus) {
+ this.instanceRecipientStatus = instanceRecipientStatus;
+ return this;
+ }
+
+ /**
+ * Get instanceRecipientStatus.
+ * @return instanceRecipientStatus
+ **/
+ @Schema(description = "")
+ public InstanceRecipientStatus getInstanceRecipientStatus() {
+ return instanceRecipientStatus;
+ }
+
+ /**
+ * setInstanceRecipientStatus.
+ **/
+ public void setInstanceRecipientStatus(InstanceRecipientStatus instanceRecipientStatus) {
+ this.instanceRecipientStatus = instanceRecipientStatus;
+ }
+
+
+ /**
+ * roleName.
+ *
+ * @return WebFormInstanceRecipients
+ **/
+ public WebFormInstanceRecipients roleName(String roleName) {
+ this.roleName = roleName;
+ return this;
+ }
+
+ /**
+ * Get roleName.
+ * @return roleName
+ **/
+ @Schema(description = "")
+ public String getRoleName() {
+ return roleName;
+ }
+
+ /**
+ * setRoleName.
+ **/
+ public void setRoleName(String roleName) {
+ this.roleName = roleName;
+ }
+
+
+ /**
+ * Compares objects.
+ *
+ * @return true or false depending on comparison result.
+ */
+ @Override
+ public boolean equals(java.lang.Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (o == null || getClass() != o.getClass()) {
+ return false;
+ }
+ WebFormInstanceRecipients webFormInstanceRecipients = (WebFormInstanceRecipients) o;
+ return Objects.equals(this.recipientViewId, webFormInstanceRecipients.recipientViewId) &&
+ Objects.equals(this.instanceRecipientStatus, webFormInstanceRecipients.instanceRecipientStatus) &&
+ Objects.equals(this.roleName, webFormInstanceRecipients.roleName);
+ }
+
+ /**
+ * Returns the HashCode.
+ */
+ @Override
+ public int hashCode() {
+ return Objects.hash(recipientViewId, instanceRecipientStatus, roleName);
+ }
+
+
+ /**
+ * Converts the given object to string.
+ */
+ @Override
+ public String toString() {
+ StringBuilder sb = new StringBuilder();
+ sb.append("class WebFormInstanceRecipients {\n");
+
+ sb.append(" recipientViewId: ").append(toIndentedString(recipientViewId)).append("\n");
+ sb.append(" instanceRecipientStatus: ").append(toIndentedString(instanceRecipientStatus)).append("\n");
+ sb.append(" roleName: ").append(toIndentedString(roleName)).append("\n");
+ sb.append("}");
+ return sb.toString();
+ }
+
+ /**
+ * Convert the given object to string with each line indented by 4 spaces
+ * (except the first line).
+ */
+ private String toIndentedString(java.lang.Object o) {
+ if (o == null) {
+ return "null";
+ }
+ return o.toString().replace("\n", "\n ");
+ }
+
+}
+
diff --git a/src/main/java/com/docusign/webforms/model/WebFormProperties.java b/src/main/java/com/docusign/webforms/model/WebFormProperties.java
index a9a2eb8..3779be3 100644
--- a/src/main/java/com/docusign/webforms/model/WebFormProperties.java
+++ b/src/main/java/com/docusign/webforms/model/WebFormProperties.java
@@ -23,6 +23,9 @@ public class WebFormProperties implements Serializable {
@JsonProperty("isPrivateAccess")
private Boolean isPrivateAccess = null;
+ @JsonProperty("allowSending")
+ private Boolean allowSending = null;
+
/**
* name.
@@ -78,6 +81,33 @@ public void setIsPrivateAccess(Boolean isPrivateAccess) {
}
+ /**
+ * allowSending.
+ *
+ * @return WebFormProperties
+ **/
+ public WebFormProperties allowSending(Boolean allowSending) {
+ this.allowSending = allowSending;
+ return this;
+ }
+
+ /**
+ * When this property is true, form can be used for remote signing..
+ * @return allowSending
+ **/
+ @Schema(example = "true", description = "When this property is true, form can be used for remote signing.")
+ public Boolean isAllowSending() {
+ return allowSending;
+ }
+
+ /**
+ * setAllowSending.
+ **/
+ public void setAllowSending(Boolean allowSending) {
+ this.allowSending = allowSending;
+ }
+
+
/**
* Compares objects.
*
@@ -93,7 +123,8 @@ public boolean equals(java.lang.Object o) {
}
WebFormProperties webFormProperties = (WebFormProperties) o;
return Objects.equals(this.name, webFormProperties.name) &&
- Objects.equals(this.isPrivateAccess, webFormProperties.isPrivateAccess);
+ Objects.equals(this.isPrivateAccess, webFormProperties.isPrivateAccess) &&
+ Objects.equals(this.allowSending, webFormProperties.allowSending);
}
/**
@@ -101,7 +132,7 @@ public boolean equals(java.lang.Object o) {
*/
@Override
public int hashCode() {
- return Objects.hash(name, isPrivateAccess);
+ return Objects.hash(name, isPrivateAccess, allowSending);
}
@@ -115,6 +146,7 @@ public String toString() {
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" isPrivateAccess: ").append(toIndentedString(isPrivateAccess)).append("\n");
+ sb.append(" allowSending: ").append(toIndentedString(allowSending)).append("\n");
sb.append("}");
return sb.toString();
}