-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathBatchItemResultModel.java
More file actions
139 lines (113 loc) · 7.38 KB
/
BatchItemResultModel.java
File metadata and controls
139 lines (113 loc) · 7.38 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
/*
* Dropsigner (HML)
* <!---------------------------------------------------------------------------------------------------------------------> <h2>Authentication</h2> <p> In order to call this APIs, you will need an <strong>API key</strong>. Set the API key in the header <span class=\"code\">X-Api-Key</span>: </p> <pre>X-Api-Key: your-app|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</pre> <!---------------------------------------------------------------------------------------------------------------------> <br /> <h2>HTTP Codes</h2> <p> The APIs will return the following HTTP codes: </p> <table> <thead> <tr> <th>Code</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><strong class=\"model-title\">200 (OK)</strong></td> <td>Request processed successfully. The response is different for each API, please refer to the operation's documentation</td> </tr> <tr> <td><strong class=\"model-title\">400 (Bad Request)</strong></td> <td>Syntax error. For instance, when a required field was not provided</td> </tr> <tr> <td><strong class=\"model-title\">401 (Unauthorized)</strong></td> <td>API key not provided or invalid</td> </tr> <tr> <td><strong class=\"model-title\">403 (Forbidden)</strong></td> <td>API key is valid, but the application has insufficient permissions to complete the requested operation</td> </tr> <tr> <td><strong class=\"model-title\">422 (Unprocessable Entity)</strong></td> <td>API error. The response is as defined in <a href=\"#model-ErrorModel\">ErrorModel</a></td> </tr> </tbody> </table> <br /> <h3>Error Codes</h3> <p>Some of the error codes returned in a 422 response are provided bellow*:</p> <ul> <li>CertificateNotFound</li> <li>DocumentNotFound</li> <li>FolderNotFound</li> <li>CpfMismatch</li> <li>CpfNotExpected</li> <li>InvalidFlowAction</li> <li>DocumentInvalidKey</li> </ul> <p style=\"font-size: 0.9em\"> *The codes shown above are the main error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning. </p> <!---------------------------------------------------------------------------------------------------------------------> <br /> <h2>Webhooks</h2> <p> It is recomended to subscribe to Webhook events <strong>instead</strong> 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. </p> <p> All requests have the format described in <a href=\"#model-Webhooks.WebhookModel\">Webhooks.WebhookModel</a>. The data field varies according to the webhook event type: </p> <table> <thead> <tr> <th>Event type</th> <th>Description</th> <th>Payload</th> </tr> </thead> <tbody> <tr> <td><strong class=\"model-title\">DocumentSigned</strong></td> <td>Triggered when a document is signed.</td> <td><a href=\"#model-Webhooks.DocumentSignedModel\">Webhooks.DocumentSignedModel</a></td> </tr> <tr> <td><strong class=\"model-title\">DocumentApproved</strong></td> <td>Triggered when a document is approved.</td> <td><a href=\"#model-Webhooks.DocumentApprovedModel\">Webhooks.DocumentApprovedModel</a></td> </tr> <tr> <td><strong class=\"model-title\">DocumentRefused</strong></td> <td>Triggered when a document is refused.</td> <td><a href=\"#model-Webhooks.DocumentRefusedModel\">Webhooks.DocumentRefusedModel</a></td> </tr> <tr> <td><strong class=\"model-title\">DocumentConcluded</strong></td> <td>Triggered when the flow of a document is concluded.</td> <td><a href=\"#model-Webhooks.DocumentConcludedModel\">Webhooks.DocumentConcludedModel</a></td> </tr> <tr> <td><strong class=\"model-title\">DocumentCanceled</strong></td> <td>Triggered when the document is canceled.</td> <td><a href=\"#model-Webhooks.DocumentCanceledModel\">Webhooks.DocumentCanceledModel</a></td> </tr> <tr> <td><strong class=\"model-title\">DocumentsCreated (v1.50.0)</strong></td> <td>Triggered when one or more documents are created.</td> <td><a href=\"#model-Webhooks.DocumentsCreatedModel\">Webhooks.DocumentsCreatedModel</a></td> </tr> </tbody> </table> <p> To register your application URL and enable Webhooks, access the integrations section in your <a href=\"/private/organizations\" target=\"_blank\">organization's details page</a>. </p>
*
* 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;
import java.util.Objects;
import java.util.UUID;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.gson.annotations.SerializedName;
import io.swagger.v3.oas.annotations.media.Schema;
/**
* BatchItemResultModel
*/
public class BatchItemResultModel {
@JsonProperty("id")
@SerializedName("id")
private UUID id = null;
@JsonProperty("success")
@SerializedName("success")
private Boolean success = null;
@JsonProperty("errorMessage")
@SerializedName("errorMessage")
private String errorMessage = null;
public BatchItemResultModel id(UUID id) {
this.id = id;
return this;
}
/**
* Get id
* @return id
**/
@Schema(description = "")
public UUID getId() {
return id;
}
public void setId(UUID id) {
this.id = id;
}
public BatchItemResultModel success(Boolean success) {
this.success = success;
return this;
}
/**
* Get success
* @return success
**/
@Schema(description = "")
public Boolean isSuccess() {
return success;
}
public void setSuccess(Boolean success) {
this.success = success;
}
public BatchItemResultModel errorMessage(String errorMessage) {
this.errorMessage = errorMessage;
return this;
}
/**
* Get errorMessage
* @return errorMessage
**/
@Schema(description = "")
public String getErrorMessage() {
return errorMessage;
}
public void setErrorMessage(String errorMessage) {
this.errorMessage = errorMessage;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
BatchItemResultModel batchItemResultModel = (BatchItemResultModel) o;
return Objects.equals(this.id, batchItemResultModel.id) &&
Objects.equals(this.success, batchItemResultModel.success) &&
Objects.equals(this.errorMessage, batchItemResultModel.errorMessage);
}
@Override
public int hashCode() {
return Objects.hash(id, success, errorMessage);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class BatchItemResultModel {\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" success: ").append(toIndentedString(success)).append("\n");
sb.append(" errorMessage: ").append(toIndentedString(errorMessage)).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 ");
}
}