com.lacunasoftware.signer.documents.CreateDocumentResult 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.documents;
import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.gson.annotations.SerializedName;
import com.lacunasoftware.signer.attachments.CreateAttachmentResult;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
/**
* CreateDocumentResult
*/
public class CreateDocumentResult {
@JsonProperty("uploadId")
@SerializedName("uploadId")
private String uploadId = null;
@JsonProperty("documentId")
@SerializedName("documentId")
private UUID documentId = null;
@JsonProperty("attachments")
@SerializedName("attachments")
private List attachments = null;
public CreateDocumentResult uploadId(String uploadId) {
this.uploadId = uploadId;
return this;
}
/**
* The Id of the uploaded file, from the request Lacuna.Signer.Api.UploadModel.Id.
* @return uploadId
**/
@Schema(description = "The Id of the uploaded file, from the request Lacuna.Signer.Api.UploadModel.Id.")
public String getUploadId() {
return uploadId;
}
public void setUploadId(String uploadId) {
this.uploadId = uploadId;
}
public CreateDocumentResult documentId(UUID documentId) {
this.documentId = documentId;
return this;
}
/**
* The Id of the newly created document.
* @return documentId
**/
@Schema(description = "The Id of the newly created document.")
public UUID getDocumentId() {
return documentId;
}
public void setDocumentId(UUID documentId) {
this.documentId = documentId;
}
public CreateDocumentResult attachments(List attachments) {
this.attachments = attachments;
return this;
}
public CreateDocumentResult addAttachmentsItem(CreateAttachmentResult attachmentsItem) {
if (this.attachments == null) {
this.attachments = new ArrayList();
}
this.attachments.add(attachmentsItem);
return this;
}
/**
* Result of creating attachments
* @return attachments
**/
@Schema(description = "Result of creating attachments")
public List getAttachments() {
return attachments;
}
public void setAttachments(List attachments) {
this.attachments = attachments;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
CreateDocumentResult documentsCreateDocumentResult = (CreateDocumentResult) o;
return Objects.equals(this.uploadId, documentsCreateDocumentResult.uploadId) &&
Objects.equals(this.documentId, documentsCreateDocumentResult.documentId) &&
Objects.equals(this.attachments, documentsCreateDocumentResult.attachments);
}
@Override
public int hashCode() {
return Objects.hash(uploadId, documentId, attachments);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class CreateDocumentResult {\n");
sb.append(" uploadId: ").append(toIndentedString(uploadId)).append("\n");
sb.append(" documentId: ").append(toIndentedString(documentId)).append("\n");
sb.append(" attachments: ").append(toIndentedString(attachments)).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 ");
}
}