All Classes Interface Summary Class Summary Enum Summary Exception Summary
Class |
Description |
AbstractOpenApiSchema |
Abstract class for oneOf,anyOf schemas defined in OpenAPI spec
|
AccountApi |
|
AccountCreateRequest |
AccountCreateRequest
|
AccountCreateResponse |
AccountCreateResponse
|
AccountGetResponse |
AccountGetResponse
|
AccountResponse |
AccountResponse
|
AccountResponseQuotas |
Details concerning remaining monthly quotas.
|
AccountUpdateRequest |
AccountUpdateRequest
|
AccountVerifyRequest |
AccountVerifyRequest
|
AccountVerifyResponse |
AccountVerifyResponse
|
AccountVerifyResponseAccount |
AccountVerifyResponseAccount
|
ApiAppApi |
|
ApiAppCreateRequest |
ApiAppCreateRequest
|
ApiAppGetResponse |
ApiAppGetResponse
|
ApiAppListResponse |
ApiAppListResponse
|
ApiAppResponse |
Contains information about an API App.
|
ApiAppResponseOAuth |
An object describing the app's OAuth properties, or null if OAuth is not configured for the app.
|
ApiAppResponseOptions |
An object with options that override account settings.
|
ApiAppResponseOwnerAccount |
An object describing the app's owner
|
ApiAppResponseWhiteLabelingOptions |
An object with options to customize the app's signer page
|
ApiAppUpdateRequest |
ApiAppUpdateRequest
|
ApiClient |
ApiClient class.
|
ApiException |
API Exception
|
ApiKeyAuth |
|
ApiResponse<T> |
API response returned by API call.
|
Authentication |
|
BulkSendJobApi |
|
BulkSendJobGetResponse |
BulkSendJobGetResponse
|
BulkSendJobGetResponseSignatureRequests |
BulkSendJobGetResponseSignatureRequests
|
BulkSendJobListResponse |
BulkSendJobListResponse
|
BulkSendJobResponse |
Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.
|
BulkSendJobSendResponse |
BulkSendJobSendResponse
|
Configuration |
|
CustomInstantDeserializer<T extends org.threeten.bp.temporal.Temporal> |
Deserializer for ThreeTen temporal Instant s, OffsetDateTime , and ZonedDateTime s.
|
EmbeddedApi |
|
EmbeddedEditUrlRequest |
EmbeddedEditUrlRequest
|
EmbeddedEditUrlResponse |
EmbeddedEditUrlResponse
|
EmbeddedEditUrlResponseEmbedded |
An embedded template object.
|
EmbeddedSignUrlResponse |
EmbeddedSignUrlResponse
|
EmbeddedSignUrlResponseEmbedded |
An object that contains necessary information to set up embedded signing.
|
ErrorResponse |
ErrorResponse
|
ErrorResponseError |
Contains information about an error that occurred.
|
EventCallbackAccountRequest |
EventCallbackAccountRequest
|
EventCallbackAccountRequestPayload |
EventCallbackAccountRequestPayload
|
EventCallbackApiAppRequest |
EventCallbackApiAppRequest
|
EventCallbackApiAppRequestPayload |
EventCallbackApiAppRequestPayload
|
EventCallbackHelper |
|
EventCallbackRequestEvent |
Basic information about the event that occurred.
|
EventCallbackRequestEvent.EventTypeEnum |
Type of callback event that was triggered.
|
EventCallbackRequestEventMetadata |
Specific metadata about the event.
|
FileResponse |
FileResponse
|
HttpBasicAuth |
|
HttpBearerAuth |
|
JavaTimeFormatter |
Class that add parsing/formatting support for Java 8+ OffsetDateTime class.
|
JSON |
|
ListInfoResponse |
Contains pagination information about the data returned.
|
OAuthApi |
|
OAuthTokenGenerateRequest |
OAuthTokenGenerateRequest
|
OAuthTokenRefreshRequest |
OAuthTokenRefreshRequest
|
OAuthTokenResponse |
OAuthTokenResponse
|
Pair |
|
ReportApi |
|
ReportCreateRequest |
ReportCreateRequest
|
ReportCreateRequest.ReportTypeEnum |
Gets or Sets reportType
|
ReportCreateResponse |
ReportCreateResponse
|
ReportResponse |
Contains information about the report request.
|
ReportResponse.ReportTypeEnum |
Gets or Sets reportType
|
RFC3339DateFormat |
|
ServerConfiguration |
Representing a Server configuration.
|
ServerVariable |
Representing a Server Variable for server URL template substitution.
|
SignatureRequestApi |
|
SignatureRequestBulkCreateEmbeddedWithTemplateRequest |
Calls SignatureRequestBulkSendWithTemplate in controller
|
SignatureRequestBulkSendWithTemplateRequest |
SignatureRequestBulkSendWithTemplateRequest
|
SignatureRequestCreateEmbeddedRequest |
Calls SignatureRequestSend in controller
|
SignatureRequestCreateEmbeddedWithTemplateRequest |
Calls SignatureRequestSend in controller
|
SignatureRequestGetResponse |
SignatureRequestGetResponse
|
SignatureRequestListResponse |
SignatureRequestListResponse
|
SignatureRequestRemindRequest |
SignatureRequestRemindRequest
|
SignatureRequestResponse |
Contains information about a signature request.
|
SignatureRequestResponseAttachment |
Signer attachments.
|
SignatureRequestResponseCustomFieldBase |
An array of Custom Field objects containing the name and type of each custom field.
|
SignatureRequestResponseCustomFieldCheckbox |
This class extends `SignatureRequestResponseCustomFieldBase`.
|
SignatureRequestResponseCustomFieldText |
This class extends `SignatureRequestResponseCustomFieldBase`.
|
SignatureRequestResponseCustomFieldTypeEnum |
Gets or Sets SignatureRequestResponseCustomFieldTypeEnum
|
SignatureRequestResponseData |
An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.
|
SignatureRequestResponseDataBase |
An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.
|
SignatureRequestResponseDataTypeEnum |
Gets or Sets SignatureRequestResponseDataTypeEnum
|
SignatureRequestResponseDataValueCheckbox |
SignatureRequestResponseDataValueCheckbox
|
SignatureRequestResponseDataValueCheckboxMerge |
SignatureRequestResponseDataValueCheckboxMerge
|
SignatureRequestResponseDataValueDateSigned |
SignatureRequestResponseDataValueDateSigned
|
SignatureRequestResponseDataValueDropdown |
SignatureRequestResponseDataValueDropdown
|
SignatureRequestResponseDataValueInitials |
SignatureRequestResponseDataValueInitials
|
SignatureRequestResponseDataValueRadio |
SignatureRequestResponseDataValueRadio
|
SignatureRequestResponseDataValueSignature |
SignatureRequestResponseDataValueSignature
|
SignatureRequestResponseDataValueText |
SignatureRequestResponseDataValueText
|
SignatureRequestResponseDataValueTextMerge |
SignatureRequestResponseDataValueTextMerge
|
SignatureRequestResponseSignatures |
An array of signature objects, 1 for each signer.
|
SignatureRequestSendRequest |
SignatureRequestSendRequest
|
SignatureRequestSendWithTemplateRequest |
SignatureRequestSendWithTemplateRequest
|
SignatureRequestUpdateRequest |
SignatureRequestUpdateRequest
|
StringUtil |
|
SubAttachment |
SubAttachment
|
SubBulkSignerList |
SubBulkSignerList
|
SubBulkSignerListCustomField |
SubBulkSignerListCustomField
|
SubCC |
SubCC
|
SubCustomField |
When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.
|
SubEditorOptions |
This allows the requester to specify editor options when a preparing a document
|
SubFieldOptions |
This allows the requester to specify field options for a signature request.
|
SubFieldOptions.DateFormatEnum |
Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats)) **Note**: Only available for Premium and higher.
|
SubFormFieldGroup |
SubFormFieldGroup
|
SubFormFieldRule |
SubFormFieldRule
|
SubFormFieldRuleAction |
SubFormFieldRuleAction
|
SubFormFieldRuleAction.TypeEnum |
Gets or Sets type
|
SubFormFieldRuleTrigger |
SubFormFieldRuleTrigger
|
SubFormFieldRuleTrigger.OperatorEnum |
Different field types allow different `operator` values: - Field type of **text**: - **is**: exact match - **not**: not exact match - **match**: regular expression, without /.
|
SubFormFieldsPerDocumentBase |
The fields that should appear on the document, expressed as an array of objects.
|
SubFormFieldsPerDocumentCheckbox |
This class extends `SubFormFieldsPerDocumentBase`.
|
SubFormFieldsPerDocumentCheckboxMerge |
This class extends `SubFormFieldsPerDocumentBase`.
|
SubFormFieldsPerDocumentDateSigned |
This class extends `SubFormFieldsPerDocumentBase`.
|
SubFormFieldsPerDocumentDropdown |
This class extends `SubFormFieldsPerDocumentBase`.
|
SubFormFieldsPerDocumentHyperlink |
This class extends `SubFormFieldsPerDocumentBase`.
|
SubFormFieldsPerDocumentInitials |
This class extends `SubFormFieldsPerDocumentBase`.
|
SubFormFieldsPerDocumentRadio |
This class extends `SubFormFieldsPerDocumentBase`.
|
SubFormFieldsPerDocumentSignature |
This class extends `SubFormFieldsPerDocumentBase`.
|
SubFormFieldsPerDocumentText |
This class extends `SubFormFieldsPerDocumentBase`.
|
SubFormFieldsPerDocumentText.ValidationTypeEnum |
Each text field may contain a `validation_type` parameter.
|
SubFormFieldsPerDocumentTextMerge |
This class extends `SubFormFieldsPerDocumentBase`.
|
SubFormFieldsPerDocumentTypeEnum |
Gets or Sets SubFormFieldsPerDocumentTypeEnum
|
SubMergeField |
SubMergeField
|
SubMergeField.TypeEnum |
The type of merge field.
|
SubOAuth |
OAuth related parameters.
|
SubOAuth.ScopesEnum |
Gets or Sets scopes
|
SubOptions |
Additional options supported by API App.
|
SubSignatureRequestSigner |
SubSignatureRequestSigner
|
SubSignatureRequestSigner.SmsPhoneNumberTypeEnum |
Specifies the feature used with the `sms_phone_number`.
|
SubSignatureRequestTemplateSigner |
SubSignatureRequestTemplateSigner
|
SubSignatureRequestTemplateSigner.SmsPhoneNumberTypeEnum |
Specifies the feature used with the `sms_phone_number`.
|
SubSigningOptions |
This allows the requester to specify the types allowed for creating a signature.
|
SubSigningOptions.DefaultTypeEnum |
The default type shown (limited to the listed types)
|
SubTeamResponse |
SubTeamResponse
|
SubTemplateRole |
SubTemplateRole
|
SubUnclaimedDraftSigner |
SubUnclaimedDraftSigner
|
SubUnclaimedDraftTemplateSigner |
SubUnclaimedDraftTemplateSigner
|
SubWhiteLabelingOptions |
An array of elements and values serialized to a string, to be used to customize the app's signer page.
|
SubWhiteLabelingOptions.LegalVersionEnum |
Gets or Sets legalVersion
|
TeamAddMemberRequest |
TeamAddMemberRequest
|
TeamAddMemberRequest.RoleEnum |
A role member will take in a new Team.
|
TeamApi |
|
TeamCreateRequest |
TeamCreateRequest
|
TeamGetInfoResponse |
TeamGetInfoResponse
|
TeamGetResponse |
TeamGetResponse
|
TeamInfoResponse |
TeamInfoResponse
|
TeamMemberResponse |
TeamMemberResponse
|
TeamMembersResponse |
TeamMembersResponse
|
TeamParentResponse |
Information about the parent team if a team has one, set to `null` otherwise.
|
TeamRemoveMemberRequest |
TeamRemoveMemberRequest
|
TeamRemoveMemberRequest.NewRoleEnum |
A new role member will take in a new Team.
|
TeamResponse |
Contains information about your team and its members
|
TeamSubTeamsResponse |
TeamSubTeamsResponse
|
TeamUpdateRequest |
TeamUpdateRequest
|
TemplateAddUserRequest |
TemplateAddUserRequest
|
TemplateApi |
|
TemplateCreateEmbeddedDraftRequest |
TemplateCreateEmbeddedDraftRequest
|
TemplateCreateEmbeddedDraftResponse |
TemplateCreateEmbeddedDraftResponse
|
TemplateCreateEmbeddedDraftResponseTemplate |
Template object with parameters: `template_id`, `edit_url`, `expires_at`.
|
TemplateEditResponse |
TemplateEditResponse
|
TemplateGetResponse |
TemplateGetResponse
|
TemplateListResponse |
TemplateListResponse
|
TemplateRemoveUserRequest |
TemplateRemoveUserRequest
|
TemplateResponse |
Contains information about the templates you and your team have created.
|
TemplateResponseAccount |
TemplateResponseAccount
|
TemplateResponseAccountQuota |
An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.
|
TemplateResponseCCRole |
TemplateResponseCCRole
|
TemplateResponseCustomField |
TemplateResponseCustomField
|
TemplateResponseCustomField.TypeEnum |
The type of this Custom Field.
|
TemplateResponseDocument |
TemplateResponseDocument
|
TemplateResponseDocumentCustomField |
TemplateResponseDocumentCustomField
|
TemplateResponseDocumentCustomField.TypeEnum |
The type of this Custom Field.
|
TemplateResponseDocumentFieldGroup |
TemplateResponseDocumentFieldGroup
|
TemplateResponseDocumentFormField |
TemplateResponseDocumentFormField
|
TemplateResponseDocumentFormField.TypeEnum |
The type of this form field.
|
TemplateResponseDocumentStaticField |
TemplateResponseDocumentStaticField
|
TemplateResponseFieldAvgTextLength |
Average text length in this field.
|
TemplateResponseNamedFormField |
TemplateResponseNamedFormField
|
TemplateResponseSignerRole |
TemplateResponseSignerRole
|
TemplateUpdateFilesRequest |
TemplateUpdateFilesRequest
|
TemplateUpdateFilesResponse |
TemplateUpdateFilesResponse
|
TemplateUpdateFilesResponseTemplate |
Contains template id
|
UnclaimedDraftApi |
|
UnclaimedDraftCreateEmbeddedRequest |
UnclaimedDraftCreateEmbeddedRequest
|
UnclaimedDraftCreateEmbeddedRequest.TypeEnum |
The type of the draft.
|
UnclaimedDraftCreateEmbeddedWithTemplateRequest |
UnclaimedDraftCreateEmbeddedWithTemplateRequest
|
UnclaimedDraftCreateRequest |
UnclaimedDraftCreateRequest
|
UnclaimedDraftCreateRequest.TypeEnum |
The type of unclaimed draft to create.
|
UnclaimedDraftCreateResponse |
UnclaimedDraftCreateResponse
|
UnclaimedDraftEditAndResendRequest |
UnclaimedDraftEditAndResendRequest
|
UnclaimedDraftResponse |
A group of documents that a user can take ownership of via the claim URL.
|
WarningResponse |
A list of warnings.
|