-
Notifications
You must be signed in to change notification settings - Fork 30
Expand file tree
/
Copy pathAgreementInfo.java
More file actions
892 lines (725 loc) · 33 KB
/
AgreementInfo.java
File metadata and controls
892 lines (725 loc) · 33 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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
/*
*
* No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
*
* OpenAPI spec version: 6.0.0
*
*
* 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 io.swagger.client.model;
import java.util.Objects;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import io.swagger.client.model.AgreementCcInfo;
import io.swagger.client.model.EmailOption;
import io.swagger.client.model.ExternalId;
import io.swagger.client.model.FileInfo;
import io.swagger.client.model.OfflineDeviceInfo;
import io.swagger.client.model.ParticipantSetInfo;
import io.swagger.client.model.PostSignOption;
import io.swagger.client.model.SecurityOption;
import io.swagger.client.model.VaultingInfo;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
/**
* AgreementInfo
*/
@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2018-09-06T11:30:55.372+05:30")
public class AgreementInfo {
@SerializedName("ccs")
private List<AgreementCcInfo> ccs = null;
@SerializedName("createdDate")
private Date createdDate = null;
@SerializedName("deviceInfo")
private OfflineDeviceInfo deviceInfo = null;
@SerializedName("documentVisibilityEnabled")
private Boolean documentVisibilityEnabled = null;
@SerializedName("emailOption")
private EmailOption emailOption = null;
@SerializedName("expirationTime")
private Date expirationTime = null;
@SerializedName("externalId")
private ExternalId externalId = null;
@SerializedName("fileInfos")
private List<FileInfo> fileInfos = null;
@SerializedName("firstReminderDelay")
private Integer firstReminderDelay = null;
@SerializedName("id")
private String id = null;
@SerializedName("locale")
private String locale = null;
@SerializedName("message")
private String message = null;
@SerializedName("name")
private String name = null;
@SerializedName("participantSetsInfo")
private List<ParticipantSetInfo> participantSetsInfo = null;
@SerializedName("postSignOption")
private PostSignOption postSignOption = null;
@SerializedName("mergeFieldInfo")
private List<MergefieldInfo> mergeFieldInfo = null;
/**
* Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used. Should not be provided in offline agreement creation.
*/
@JsonAdapter(ReminderFrequencyEnum.Adapter.class)
public enum ReminderFrequencyEnum {
DAILY_UNTIL_SIGNED("DAILY_UNTIL_SIGNED"),
WEEKLY_UNTIL_SIGNED("WEEKLY_UNTIL_SIGNED");
private String value;
ReminderFrequencyEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static ReminderFrequencyEnum fromValue(String text) {
for (ReminderFrequencyEnum b : ReminderFrequencyEnum.values()) {
if (String.valueOf(b.value).equals(text)) {
return b;
}
}
return null;
}
public static class Adapter extends TypeAdapter<ReminderFrequencyEnum> {
@Override
public void write(final JsonWriter jsonWriter, final ReminderFrequencyEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public ReminderFrequencyEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return ReminderFrequencyEnum.fromValue(String.valueOf(value));
}
}
}
@SerializedName("reminderFrequency")
private ReminderFrequencyEnum reminderFrequency = null;
@SerializedName("securityOption")
private SecurityOption securityOption = null;
@SerializedName("senderEmail")
private String senderEmail = null;
/**
* Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system
*/
@JsonAdapter(SignatureTypeEnum.Adapter.class)
public enum SignatureTypeEnum {
ESIGN("ESIGN"),
WRITTEN("WRITTEN");
private String value;
SignatureTypeEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static SignatureTypeEnum fromValue(String text) {
for (SignatureTypeEnum b : SignatureTypeEnum.values()) {
if (String.valueOf(b.value).equals(text)) {
return b;
}
}
return null;
}
public static class Adapter extends TypeAdapter<SignatureTypeEnum> {
@Override
public void write(final JsonWriter jsonWriter, final SignatureTypeEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public SignatureTypeEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return SignatureTypeEnum.fromValue(String.valueOf(value));
}
}
}
@SerializedName("signatureType")
private SignatureTypeEnum signatureType = null;
/**
* The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID
*/
@JsonAdapter(StateEnum.Adapter.class)
public enum StateEnum {
AUTHORING("AUTHORING"),
DRAFT("DRAFT"),
IN_PROCESS("IN_PROCESS");
private String value;
StateEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static StateEnum fromValue(String text) {
for (StateEnum b : StateEnum.values()) {
if (String.valueOf(b.value).equals(text)) {
return b;
}
}
return null;
}
public static class Adapter extends TypeAdapter<StateEnum> {
@Override
public void write(final JsonWriter jsonWriter, final StateEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public StateEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return StateEnum.fromValue(String.valueOf(value));
}
}
}
@SerializedName("state")
private StateEnum state = null;
/**
* This is a server generated attribute which provides the detailed status of an agreement.
*/
@JsonAdapter(StatusEnum.Adapter.class)
public enum StatusEnum {
OUT_FOR_SIGNATURE("OUT_FOR_SIGNATURE"),
OUT_FOR_DELIVERY("OUT_FOR_DELIVERY"),
OUT_FOR_ACCEPTANCE("OUT_FOR_ACCEPTANCE"),
OUT_FOR_FORM_FILLING("OUT_FOR_FORM_FILLING"),
OUT_FOR_APPROVAL("OUT_FOR_APPROVAL"),
AUTHORING("AUTHORING"),
CANCELLED("CANCELLED"),
SIGNED("SIGNED"),
APPROVED("APPROVED"),
DELIVERED("DELIVERED"),
ACCEPTED("ACCEPTED"),
FORM_FILLED("FORM_FILLED"),
EXPIRED("EXPIRED"),
ARCHIVED("ARCHIVED"),
PREFILL("PREFILL"),
WIDGET_WAITING_FOR_VERIFICATION("WIDGET_WAITING_FOR_VERIFICATION"),
DRAFT("DRAFT"),
DOCUMENTS_NOT_YET_PROCESSED("DOCUMENTS_NOT_YET_PROCESSED"),
WAITING_FOR_FAXIN("WAITING_FOR_FAXIN"),
WAITING_FOR_VERIFICATION("WAITING_FOR_VERIFICATION");
private String value;
StatusEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static StatusEnum fromValue(String text) {
for (StatusEnum b : StatusEnum.values()) {
if (String.valueOf(b.value).equals(text)) {
return b;
}
}
return null;
}
public static class Adapter extends TypeAdapter<StatusEnum> {
@Override
public void write(final JsonWriter jsonWriter, final StatusEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public StatusEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return StatusEnum.fromValue(String.valueOf(value));
}
}
}
@SerializedName("status")
private StatusEnum status = null;
@SerializedName("vaultingInfo")
private VaultingInfo vaultingInfo = null;
@SerializedName("workflowId")
private String workflowId = null;
public AgreementInfo ccs(List<AgreementCcInfo> ccs) {
this.ccs = ccs;
return this;
}
public AgreementInfo addCcsItem(AgreementCcInfo ccsItem) {
if (this.ccs == null) {
this.ccs = new ArrayList<AgreementCcInfo>();
}
this.ccs.add(ccsItem);
return this;
}
/**
* A list of one or more CCs that will be copied in the agreement transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file. Should not be provided in offline agreement creation.
* @return ccs
**/
@ApiModelProperty(value = "A list of one or more CCs that will be copied in the agreement transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file. Should not be provided in offline agreement creation.")
public List<AgreementCcInfo> getCcs() {
return ccs;
}
public void setCcs(List<AgreementCcInfo> ccs) {
this.ccs = ccs;
}
public AgreementInfo createdDate(Date createdDate) {
this.createdDate = createdDate;
return this;
}
/**
* Date when agreement was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time
* @return createdDate
**/
@ApiModelProperty(value = "Date when agreement was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time")
public Date getCreatedDate() {
return createdDate;
}
public void setCreatedDate(Date createdDate) {
this.createdDate = createdDate;
}
public AgreementInfo deviceInfo(OfflineDeviceInfo deviceInfo) {
this.deviceInfo = deviceInfo;
return this;
}
/**
* Device info of the offline device. It should only be provided in case of offline agreement creation.
* @return deviceInfo
**/
@ApiModelProperty(value = "Device info of the offline device. It should only be provided in case of offline agreement creation.")
public OfflineDeviceInfo getDeviceInfo() {
return deviceInfo;
}
public void setDeviceInfo(OfflineDeviceInfo deviceInfo) {
this.deviceInfo = deviceInfo;
}
public AgreementInfo documentVisibilityEnabled(Boolean documentVisibilityEnabled) {
this.documentVisibilityEnabled = documentVisibilityEnabled;
return this;
}
/**
* If set to true, enable limited document visibility. Should not be provided in offline agreement creation.
* @return documentVisibilityEnabled
**/
@ApiModelProperty(value = "If set to true, enable limited document visibility. Should not be provided in offline agreement creation.")
public Boolean isDocumentVisibilityEnabled() {
return documentVisibilityEnabled;
}
public void setDocumentVisibilityEnabled(Boolean documentVisibilityEnabled) {
this.documentVisibilityEnabled = documentVisibilityEnabled;
}
public AgreementInfo emailOption(EmailOption emailOption) {
this.emailOption = emailOption;
return this;
}
/**
* Email configurations for the agreement. Should not be provided in offline agreement creation.
* @return emailOption
**/
@ApiModelProperty(value = "Email configurations for the agreement. Should not be provided in offline agreement creation.")
public EmailOption getEmailOption() {
return emailOption;
}
public void setEmailOption(EmailOption emailOption) {
this.emailOption = emailOption;
}
public AgreementInfo expirationTime(Date expirationTime) {
this.expirationTime = expirationTime;
return this;
}
/**
* Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation.
* @return expirationTime
**/
@ApiModelProperty(value = "Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation.")
public Date getExpirationTime() {
return expirationTime;
}
public void setExpirationTime(Date expirationTime) {
this.expirationTime = expirationTime;
}
public AgreementInfo externalId(ExternalId externalId) {
this.externalId = externalId;
return this;
}
/**
* An arbitrary value from your system, which can be specified at sending time and then later returned or queried. Should not be provided in offline agreement creation.
* @return externalId
**/
@ApiModelProperty(value = "An arbitrary value from your system, which can be specified at sending time and then later returned or queried. Should not be provided in offline agreement creation.")
public ExternalId getExternalId() {
return externalId;
}
public void setExternalId(ExternalId externalId) {
this.externalId = externalId;
}
public AgreementInfo mergeFieldInfo(List<MergefieldInfo> mergeFieldInfo) {
this.mergeFieldInfo = mergeFieldInfo;
return this;
}
public AgreementInfo addMergeFieldInfoItem(MergefieldInfo mergeFieldInfoItem) {
if (this.mergeFieldInfo == null) {
this.mergeFieldInfo = new ArrayList<MergefieldInfo>();
}
this.mergeFieldInfo.add(mergeFieldInfoItem);
return this;
}
public AgreementInfo fileInfos(List<FileInfo> fileInfos) {
this.fileInfos = fileInfos;
return this;
}
public AgreementInfo addFileInfosItem(FileInfo fileInfosItem) {
if (this.fileInfos == null) {
this.fileInfos = new ArrayList<FileInfo>();
}
this.fileInfos.add(fileInfosItem);
return this;
}
/**
* A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified
* @return fileInfos
**/
@ApiModelProperty(value = "A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified")
public List<FileInfo> getFileInfos() {
return fileInfos;
}
public void setFileInfos(List<FileInfo> fileInfos) {
this.fileInfos = fileInfos;
}
/**
* Optional default values for fields to merge into the document. The values will be presented to the signers for editable fields; for read-only fields the provided values will not be editable during the signing process. Merging data into fields is currently not supported when used with libraryDocumentId or libraryDocumentName. Only file and url are currently supported
* @return mergeFieldInfo
**/
@ApiModelProperty(value = "Optional default values for fields to merge into the document. The values will be presented to the signers for editable fields; for read-only fields the provided values will not be editable during the signing process. Merging data into fields is currently not supported when used with libraryDocumentId or libraryDocumentName. Only file and url are currently supported")
public List<MergefieldInfo> getMergeFieldInfo() {
return mergeFieldInfo;
}
public void setMergeFieldInfo(List<MergefieldInfo> mergeFieldInfo) {
this.mergeFieldInfo = mergeFieldInfo;
}
public AgreementInfo firstReminderDelay(Integer firstReminderDelay) {
this.firstReminderDelay = firstReminderDelay;
return this;
}
/**
* Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Should not be provided in offline agreement creation.
* @return firstReminderDelay
**/
@ApiModelProperty(value = "Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Should not be provided in offline agreement creation.")
public Integer getFirstReminderDelay() {
return firstReminderDelay;
}
public void setFirstReminderDelay(Integer firstReminderDelay) {
this.firstReminderDelay = firstReminderDelay;
}
public AgreementInfo id(String id) {
this.id = id;
return this;
}
/**
* The unique identifier of the agreement.If provided in POST, it will simply be ignored
* @return id
**/
@ApiModelProperty(value = "The unique identifier of the agreement.If provided in POST, it will simply be ignored")
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public AgreementInfo locale(String locale) {
this.locale = locale;
return this;
}
/**
* The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender
* @return locale
**/
@ApiModelProperty(value = "The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender")
public String getLocale() {
return locale;
}
public void setLocale(String locale) {
this.locale = locale;
}
public AgreementInfo message(String message) {
this.message = message;
return this;
}
/**
* An optional message to the participants, describing what is being sent or why their signature is required
* @return message
**/
@ApiModelProperty(value = "An optional message to the participants, describing what is being sent or why their signature is required")
public String getMessage() {
return message;
}
public void setMessage(String message) {
this.message = message;
}
public AgreementInfo name(String name) {
this.name = name;
return this;
}
/**
* The name of the agreement that will be used to identify it, in emails, website and other places
* @return name
**/
@ApiModelProperty(value = "The name of the agreement that will be used to identify it, in emails, website and other places")
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public AgreementInfo participantSetsInfo(List<ParticipantSetInfo> participantSetsInfo) {
this.participantSetsInfo = participantSetsInfo;
return this;
}
public AgreementInfo addParticipantSetsInfoItem(ParticipantSetInfo participantSetsInfoItem) {
if (this.participantSetsInfo == null) {
this.participantSetsInfo = new ArrayList<ParticipantSetInfo>();
}
this.participantSetsInfo.add(participantSetsInfoItem);
return this;
}
/**
* A list of one or more participant set. A participant set may have one or more participant. If any member of the participant set takes the action that has been assigned to the set(Sign/Approve/Acknowledge etc ), the action is considered as the action taken by whole participation set. For regular (non-MegaSign) documents, there is no limit on the number of electronic signatures in a single document. Written signatures are limited to four per document
* @return participantSetsInfo
**/
@ApiModelProperty(value = "A list of one or more participant set. A participant set may have one or more participant. If any member of the participant set takes the action that has been assigned to the set(Sign/Approve/Acknowledge etc ), the action is considered as the action taken by whole participation set. For regular (non-MegaSign) documents, there is no limit on the number of electronic signatures in a single document. Written signatures are limited to four per document")
public List<ParticipantSetInfo> getParticipantSetsInfo() {
return participantSetsInfo;
}
public void setParticipantSetsInfo(List<ParticipantSetInfo> participantSetsInfo) {
this.participantSetsInfo = participantSetsInfo;
}
public AgreementInfo postSignOption(PostSignOption postSignOption) {
this.postSignOption = postSignOption;
return this;
}
/**
* URL and associated properties for the success page the user will be taken to after completing the signing process. Should not be provided in offline agreement creation.
* @return postSignOption
**/
@ApiModelProperty(value = "URL and associated properties for the success page the user will be taken to after completing the signing process. Should not be provided in offline agreement creation.")
public PostSignOption getPostSignOption() {
return postSignOption;
}
public void setPostSignOption(PostSignOption postSignOption) {
this.postSignOption = postSignOption;
}
public AgreementInfo reminderFrequency(ReminderFrequencyEnum reminderFrequency) {
this.reminderFrequency = reminderFrequency;
return this;
}
/**
* Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used. Should not be provided in offline agreement creation.
* @return reminderFrequency
**/
@ApiModelProperty(value = "Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used. Should not be provided in offline agreement creation.")
public ReminderFrequencyEnum getReminderFrequency() {
return reminderFrequency;
}
public void setReminderFrequency(ReminderFrequencyEnum reminderFrequency) {
this.reminderFrequency = reminderFrequency;
}
public AgreementInfo securityOption(SecurityOption securityOption) {
this.securityOption = securityOption;
return this;
}
/**
* Optional secondary security parameters for the agreement. Should not be provided in offline agreement creation.
* @return securityOption
**/
@ApiModelProperty(value = "Optional secondary security parameters for the agreement. Should not be provided in offline agreement creation.")
public SecurityOption getSecurityOption() {
return securityOption;
}
public void setSecurityOption(SecurityOption securityOption) {
this.securityOption = securityOption;
}
public AgreementInfo senderEmail(String senderEmail) {
this.senderEmail = senderEmail;
return this;
}
/**
* Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored
* @return senderEmail
**/
@ApiModelProperty(value = "Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored")
public String getSenderEmail() {
return senderEmail;
}
public void setSenderEmail(String senderEmail) {
this.senderEmail = senderEmail;
}
public AgreementInfo signatureType(SignatureTypeEnum signatureType) {
this.signatureType = signatureType;
return this;
}
/**
* Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system
* @return signatureType
**/
@ApiModelProperty(value = "Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system")
public SignatureTypeEnum getSignatureType() {
return signatureType;
}
public void setSignatureType(SignatureTypeEnum signatureType) {
this.signatureType = signatureType;
}
public AgreementInfo state(StateEnum state) {
this.state = state;
return this;
}
/**
* The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID
* @return state
**/
@ApiModelProperty(value = "The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID")
public StateEnum getState() {
return state;
}
public void setState(StateEnum state) {
this.state = state;
}
public AgreementInfo status(StatusEnum status) {
this.status = status;
return this;
}
/**
* This is a server generated attribute which provides the detailed status of an agreement.
* @return status
**/
@ApiModelProperty(value = "This is a server generated attribute which provides the detailed status of an agreement.")
public StatusEnum getStatus() {
return status;
}
public void setStatus(StatusEnum status) {
this.status = status;
}
public AgreementInfo vaultingInfo(VaultingInfo vaultingInfo) {
this.vaultingInfo = vaultingInfo;
return this;
}
/**
* Vaulting properties that allows Adobe Sign to securely store documents with a vault provider
* @return vaultingInfo
**/
@ApiModelProperty(value = "Vaulting properties that allows Adobe Sign to securely store documents with a vault provider")
public VaultingInfo getVaultingInfo() {
return vaultingInfo;
}
public void setVaultingInfo(VaultingInfo vaultingInfo) {
this.vaultingInfo = vaultingInfo;
}
public AgreementInfo workflowId(String workflowId) {
this.workflowId = workflowId;
return this;
}
/**
* The identifier of custom workflow which defines the routing path of an agreement. Should not be provided in offline agreement creation.
* @return workflowId
**/
@ApiModelProperty(value = "The identifier of custom workflow which defines the routing path of an agreement. Should not be provided in offline agreement creation.")
public String getWorkflowId() {
return workflowId;
}
public void setWorkflowId(String workflowId) {
this.workflowId = workflowId;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
AgreementInfo agreementInfo = (AgreementInfo) o;
return Objects.equals(this.ccs, agreementInfo.ccs) &&
Objects.equals(this.createdDate, agreementInfo.createdDate) &&
Objects.equals(this.deviceInfo, agreementInfo.deviceInfo) &&
Objects.equals(this.documentVisibilityEnabled, agreementInfo.documentVisibilityEnabled) &&
Objects.equals(this.emailOption, agreementInfo.emailOption) &&
Objects.equals(this.expirationTime, agreementInfo.expirationTime) &&
Objects.equals(this.externalId, agreementInfo.externalId) &&
Objects.equals(this.fileInfos, agreementInfo.fileInfos) &&
Objects.equals(this.mergeFieldInfo, agreementInfo.mergeFieldInfo) &&
Objects.equals(this.firstReminderDelay, agreementInfo.firstReminderDelay) &&
Objects.equals(this.id, agreementInfo.id) &&
Objects.equals(this.locale, agreementInfo.locale) &&
Objects.equals(this.message, agreementInfo.message) &&
Objects.equals(this.name, agreementInfo.name) &&
Objects.equals(this.participantSetsInfo, agreementInfo.participantSetsInfo) &&
Objects.equals(this.postSignOption, agreementInfo.postSignOption) &&
Objects.equals(this.reminderFrequency, agreementInfo.reminderFrequency) &&
Objects.equals(this.securityOption, agreementInfo.securityOption) &&
Objects.equals(this.senderEmail, agreementInfo.senderEmail) &&
Objects.equals(this.signatureType, agreementInfo.signatureType) &&
Objects.equals(this.state, agreementInfo.state) &&
Objects.equals(this.status, agreementInfo.status) &&
Objects.equals(this.vaultingInfo, agreementInfo.vaultingInfo) &&
Objects.equals(this.workflowId, agreementInfo.workflowId);
}
@Override
public int hashCode() {
return Objects.hash(ccs, createdDate, deviceInfo, documentVisibilityEnabled, emailOption, expirationTime, externalId, fileInfos, mergeFieldInfo, firstReminderDelay, id, locale, message, name, participantSetsInfo, postSignOption, reminderFrequency, securityOption, senderEmail, signatureType, state, status, vaultingInfo, workflowId);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class AgreementInfo {\n");
sb.append(" ccs: ").append(toIndentedString(ccs)).append("\n");
sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n");
sb.append(" deviceInfo: ").append(toIndentedString(deviceInfo)).append("\n");
sb.append(" documentVisibilityEnabled: ").append(toIndentedString(documentVisibilityEnabled)).append("\n");
sb.append(" emailOption: ").append(toIndentedString(emailOption)).append("\n");
sb.append(" expirationTime: ").append(toIndentedString(expirationTime)).append("\n");
sb.append(" externalId: ").append(toIndentedString(externalId)).append("\n");
sb.append(" fileInfos: ").append(toIndentedString(fileInfos)).append("\n");
sb.append(" mergeFieldInfo: ").append(toIndentedString(mergeFieldInfo)).append("\n");
sb.append(" firstReminderDelay: ").append(toIndentedString(firstReminderDelay)).append("\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" locale: ").append(toIndentedString(locale)).append("\n");
sb.append(" message: ").append(toIndentedString(message)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" participantSetsInfo: ").append(toIndentedString(participantSetsInfo)).append("\n");
sb.append(" postSignOption: ").append(toIndentedString(postSignOption)).append("\n");
sb.append(" reminderFrequency: ").append(toIndentedString(reminderFrequency)).append("\n");
sb.append(" securityOption: ").append(toIndentedString(securityOption)).append("\n");
sb.append(" senderEmail: ").append(toIndentedString(senderEmail)).append("\n");
sb.append(" signatureType: ").append(toIndentedString(signatureType)).append("\n");
sb.append(" state: ").append(toIndentedString(state)).append("\n");
sb.append(" status: ").append(toIndentedString(status)).append("\n");
sb.append(" vaultingInfo: ").append(toIndentedString(vaultingInfo)).append("\n");
sb.append(" workflowId: ").append(toIndentedString(workflowId)).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 ");
}
}