Package com.hellosign.openapi.model

Class Summary

Class	Description
AbstractOpenApiSchema	Abstract class for oneOf,anyOf schemas defined in OpenAPI spec
AccountCreateRequest	AccountCreateRequest
AccountCreateResponse	AccountCreateResponse
AccountGetResponse	AccountGetResponse
AccountResponse	AccountResponse
AccountResponseQuotas	Details concerning remaining monthly quotas.
AccountUpdateRequest	AccountUpdateRequest
AccountVerifyRequest	AccountVerifyRequest
AccountVerifyResponse	AccountVerifyResponse
AccountVerifyResponseAccount	AccountVerifyResponseAccount
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
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
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
EventCallbackRequestEvent	Basic information about the event that occurred.
EventCallbackRequestEventMetadata	Specific metadata about the event.
FileResponse	FileResponse
ListInfoResponse	Contains pagination information about the data returned.
OAuthTokenGenerateRequest	OAuthTokenGenerateRequest
OAuthTokenRefreshRequest	OAuthTokenRefreshRequest
OAuthTokenResponse	OAuthTokenResponse
ReportCreateRequest	ReportCreateRequest
ReportCreateResponse	ReportCreateResponse
ReportResponse	Contains information about the report request.
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`.
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.
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
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.
SubFormFieldGroup	SubFormFieldGroup
SubFormFieldRule	SubFormFieldRule
SubFormFieldRuleAction	SubFormFieldRuleAction
SubFormFieldRuleTrigger	SubFormFieldRuleTrigger
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`.
SubFormFieldsPerDocumentTextMerge	This class extends `SubFormFieldsPerDocumentBase`.
SubMergeField	SubMergeField
SubOAuth	OAuth related parameters.
SubOptions	Additional options supported by API App.
SubSignatureRequestSigner	SubSignatureRequestSigner
SubSignatureRequestTemplateSigner	SubSignatureRequestTemplateSigner
SubSigningOptions	This allows the requester to specify the types allowed for creating a signature.
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.
TeamAddMemberRequest	TeamAddMemberRequest
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
TeamResponse	Contains information about your team and its members
TeamSubTeamsResponse	TeamSubTeamsResponse
TeamUpdateRequest	TeamUpdateRequest
TemplateAddUserRequest	TemplateAddUserRequest
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
TemplateResponseDocument	TemplateResponseDocument
TemplateResponseDocumentCustomField	TemplateResponseDocumentCustomField
TemplateResponseDocumentFieldGroup	TemplateResponseDocumentFieldGroup
TemplateResponseDocumentFormField	TemplateResponseDocumentFormField
TemplateResponseDocumentStaticField	TemplateResponseDocumentStaticField
TemplateResponseFieldAvgTextLength	Average text length in this field.
TemplateResponseNamedFormField	TemplateResponseNamedFormField
TemplateResponseSignerRole	TemplateResponseSignerRole
TemplateUpdateFilesRequest	TemplateUpdateFilesRequest
TemplateUpdateFilesResponse	TemplateUpdateFilesResponse
TemplateUpdateFilesResponseTemplate	Contains template id
UnclaimedDraftCreateEmbeddedRequest	UnclaimedDraftCreateEmbeddedRequest
UnclaimedDraftCreateEmbeddedWithTemplateRequest	UnclaimedDraftCreateEmbeddedWithTemplateRequest
UnclaimedDraftCreateRequest	UnclaimedDraftCreateRequest
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.

Enum Summary

Enum	Description
EventCallbackRequestEvent.EventTypeEnum	Type of callback event that was triggered.
ReportCreateRequest.ReportTypeEnum	Gets or Sets reportType
ReportResponse.ReportTypeEnum	Gets or Sets reportType
SignatureRequestResponseCustomFieldTypeEnum	Gets or Sets SignatureRequestResponseCustomFieldTypeEnum
SignatureRequestResponseDataTypeEnum	Gets or Sets SignatureRequestResponseDataTypeEnum
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.
SubFormFieldRuleAction.TypeEnum	Gets or Sets type
SubFormFieldRuleTrigger.OperatorEnum	Different field types allow different `operator` values: - Field type of **text**: - **is**: exact match - **not**: not exact match - **match**: regular expression, without /.
SubFormFieldsPerDocumentText.ValidationTypeEnum	Each text field may contain a `validation_type` parameter.
SubFormFieldsPerDocumentTypeEnum	Gets or Sets SubFormFieldsPerDocumentTypeEnum
SubMergeField.TypeEnum	The type of merge field.
SubOAuth.ScopesEnum	Gets or Sets scopes
SubSignatureRequestSigner.SmsPhoneNumberTypeEnum	Specifies the feature used with the `sms_phone_number`.
SubSignatureRequestTemplateSigner.SmsPhoneNumberTypeEnum	Specifies the feature used with the `sms_phone_number`.
SubSigningOptions.DefaultTypeEnum	The default type shown (limited to the listed types)
SubWhiteLabelingOptions.LegalVersionEnum	Gets or Sets legalVersion
TeamAddMemberRequest.RoleEnum	A role member will take in a new Team.
TeamRemoveMemberRequest.NewRoleEnum	A new role member will take in a new Team.
TemplateResponseCustomField.TypeEnum	The type of this Custom Field.
TemplateResponseDocumentCustomField.TypeEnum	The type of this Custom Field.
TemplateResponseDocumentFormField.TypeEnum	The type of this form field.
UnclaimedDraftCreateEmbeddedRequest.TypeEnum	The type of the draft.
UnclaimedDraftCreateRequest.TypeEnum	The type of unclaimed draft to create.