com.lacunasoftware.signer.refusal.RefusalModel Maven / Gradle / Ivy
/*
* Dropsigner (HML)
* Authentication
In order to call this APIs, you will need an API key. Set the API key in the header X-Api-Key:
X-Api-Key: your-app|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
HTTP Codes
The APIs will return the following HTTP codes:
Code Description 200 (OK) Request processed successfully. The response is different for each API, please refer to the operation's documentation 400 (Bad Request) Syntax error. For instance, when a required field was not provided 401 (Unauthorized) API key not provided or invalid 403 (Forbidden) API key is valid, but the application has insufficient permissions to complete the requested operation 422 (Unprocessable Entity) API error. The response is as defined in ErrorModel
Error Codes
Some of the error codes returned in a 422 response are provided bellow*:
- CertificateNotFound
- DocumentNotFound
- FolderNotFound
- CpfMismatch
- CpfNotExpected
- InvalidFlowAction
- DocumentInvalidKey
*The codes shown above are the main error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
Webhooks
It is recomended to subscribe to Webhook events instead of polling APIs. To do so, enable webhooks and register an URL that will receive a POST request whenever one of the events bellow occur.
All requests have the format described in Webhooks.WebhookModel. The data field varies according to the webhook event type:
Event type Description Payload DocumentSigned Triggered when a document is signed. Webhooks.DocumentSignedModel DocumentApproved Triggered when a document is approved. Webhooks.DocumentApprovedModel DocumentRefused Triggered when a document is refused. Webhooks.DocumentRefusedModel DocumentConcluded Triggered when the flow of a document is concluded. Webhooks.DocumentConcludedModel DocumentCanceled Triggered when the document is canceled. Webhooks.DocumentCanceledModel DocumentsCreated (v1.50.0) Triggered when one or more documents are created. Webhooks.DocumentsCreatedModel
To register your application URL and enable Webhooks, access the integrations section in your organization's details page.
*
* OpenAPI spec version: 1.55.2
*
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the class manually.
*/
package com.lacunasoftware.signer.refusal;
import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.gson.annotations.SerializedName;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.UUID;
import org.threeten.bp.OffsetDateTime;
/**
* RefusalModel
*/
public class RefusalModel {
@JsonProperty("flowActionId")
@SerializedName("flowActionId")
private UUID flowActionId = null;
@JsonProperty("reason")
@SerializedName("reason")
private String reason = null;
@JsonProperty("date")
@SerializedName("date")
private OffsetDateTime date = null;
@JsonProperty("userId")
@SerializedName("userId")
private UUID userId = null;
@JsonProperty("name")
@SerializedName("name")
private String name = null;
@JsonProperty("identifier")
@SerializedName("identifier")
private String identifier = null;
@JsonProperty("emailAddress")
@SerializedName("emailAddress")
private String emailAddress = null;
public RefusalModel flowActionId(UUID flowActionId) {
this.flowActionId = flowActionId;
return this;
}
/**
* Get flowActionId
* @return flowActionId
**/
@Schema(description = "")
public UUID getFlowActionId() {
return flowActionId;
}
public void setFlowActionId(UUID flowActionId) {
this.flowActionId = flowActionId;
}
public RefusalModel reason(String reason) {
this.reason = reason;
return this;
}
/**
* Get reason
* @return reason
**/
@Schema(description = "")
public String getReason() {
return reason;
}
public void setReason(String reason) {
this.reason = reason;
}
public RefusalModel date(OffsetDateTime date) {
this.date = date;
return this;
}
/**
* Get date
* @return date
**/
@Schema(description = "")
public OffsetDateTime getDate() {
return date;
}
public void setDate(OffsetDateTime date) {
this.date = date;
}
public RefusalModel userId(UUID userId) {
this.userId = userId;
return this;
}
/**
* Get userId
* @return userId
**/
@Schema(description = "")
public UUID getUserId() {
return userId;
}
public void setUserId(UUID userId) {
this.userId = userId;
}
public RefusalModel name(String name) {
this.name = name;
return this;
}
/**
* Get name
* @return name
**/
@Schema(description = "")
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public RefusalModel identifier(String identifier) {
this.identifier = identifier;
return this;
}
/**
* Get identifier
* @return identifier
**/
@Schema(description = "")
public String getIdentifier() {
return identifier;
}
public void setIdentifier(String identifier) {
this.identifier = identifier;
}
public RefusalModel emailAddress(String emailAddress) {
this.emailAddress = emailAddress;
return this;
}
/**
* Get emailAddress
* @return emailAddress
**/
@Schema(description = "")
public String getEmailAddress() {
return emailAddress;
}
public void setEmailAddress(String emailAddress) {
this.emailAddress = emailAddress;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
RefusalModel refusalRefusalModel = (RefusalModel) o;
return Objects.equals(this.flowActionId, refusalRefusalModel.flowActionId) &&
Objects.equals(this.reason, refusalRefusalModel.reason) &&
Objects.equals(this.date, refusalRefusalModel.date) &&
Objects.equals(this.userId, refusalRefusalModel.userId) &&
Objects.equals(this.name, refusalRefusalModel.name) &&
Objects.equals(this.identifier, refusalRefusalModel.identifier) &&
Objects.equals(this.emailAddress, refusalRefusalModel.emailAddress);
}
@Override
public int hashCode() {
return Objects.hash(flowActionId, reason, date, userId, name, identifier, emailAddress);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class RefusalModel {\n");
sb.append(" flowActionId: ").append(toIndentedString(flowActionId)).append("\n");
sb.append(" reason: ").append(toIndentedString(reason)).append("\n");
sb.append(" date: ").append(toIndentedString(date)).append("\n");
sb.append(" userId: ").append(toIndentedString(userId)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" identifier: ").append(toIndentedString(identifier)).append("\n");
sb.append(" emailAddress: ").append(toIndentedString(emailAddress)).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 ");
}
}