Documentation

ReportInProductRunResponseRowFields
in package

DocuSign

eSign

implements ModelInterface, ArrayAccess

ReportInProductRunResponseRowFields Class Doc Comment

Interfaces, Classes, Traits and Enums

ModelInterface: Interface abstracting model access.
ArrayAccess

DISCRIMINATOR = null
$attributeMap : array<string|int, string>: Array of attributes where the key is the local name, and the value is the original name
$container : array<string|int, mixed>: Associative array for storing property values
$getters : array<string|int, string>: Array of attributes to getter functions (for serialization of requests)
$setters : array<string|int, string>: Array of attributes to setter functions (for deserialization of responses)
$swaggerFormats : array<string|int, string>: Array of property to format mappings. Used for (de)serialization
$swaggerModelName : string: The original name of the model.
$swaggerTypes : array<string|int, string>: Array of property to type mappings. Used for (de)serialization
__construct() : mixed: Constructor
__toString() : string: Gets the string presentation of the object
attributeMap() : array<string|int, mixed>: Array of attributes where the key is the local name, and the value is the original name
getAccessCodeRequired() : string|null: Gets access_code_required
getAccessCodesAttempted() : string|null: Gets access_codes_attempted
getAccessCodesFailed() : string|null: Gets access_codes_failed
getAccountId() : string|null: Gets account_id
getAuthenticationCategory() : string|null: Gets authentication_category
getAuthenticationSuccess() : string|null: Gets authentication_success
getAuthenticationType() : string|null: Gets authentication_type
getAverageTimeToCompleteSeconds() : string|null: Gets average_time_to_complete_seconds
getAvgCompleteSeconds() : string|null: Gets avg_complete_seconds
getCaptureMethod() : string|null: Gets capture_method
getCompleted() : string|null: Gets completed
getCompletedTs() : string|null: Gets completed_ts
getCreatedDate() : string|null: Gets created_date
getCreatedOn() : string|null: Gets created_on
getCreator() : string|null: Gets creator
getCustomField() : string|null: Gets custom_field
getDeclinedDate() : string|null: Gets declined_date
getDeclinedReason() : string|null: Gets declined_reason
getDeliveredDate() : string|null: Gets delivered_date
getEnvelopeCount() : string|null: Gets envelope_count
getEnvelopeCreator() : string|null: Gets envelope_creator
getEnvelopeId() : string|null: Gets envelope_id
getEnvelopeInitialSendTs() : string|null: Gets envelope_initial_send_ts
getEnvelopesBilled() : string|null: Gets envelopes_billed
getEnvelopesCompleted() : string|null: Gets envelopes_completed
getEnvelopesCompletedCount() : string|null: Gets envelopes_completed_count
getEnvelopesDeclined() : string|null: Gets envelopes_declined
getEnvelopesSent() : string|null: Gets envelopes_sent
getEnvelopesSentCount() : string|null: Gets envelopes_sent_count
getEnvelopesVoided() : string|null: Gets envelopes_voided
getEnvelopeVoidedReason() : string|null: Gets envelope_voided_reason
getEodDocumentDescription() : string|null: Gets eod_document_description
getEodDocumentName() : string|null: Gets eod_document_name
getEodDocumentProfileId() : string|null: Gets eod_document_profile_id
getEodTransactionId() : string|null: Gets eod_transaction_id
getEodTransactionName() : string|null: Gets eod_transaction_name
getEventDate() : string|null: Gets event_date
getExpirationDate() : string|null: Gets expiration_date
getExpiredTs() : string|null: Gets expired_ts
getFailureReason() : string|null: Gets failure_reason
getFailures() : string|null: Gets failures
getFailureVendorCode() : string|null: Gets failure_vendor_code
getFailureVendorReason() : string|null: Gets failure_vendor_reason
getFirstSendTs() : string|null: Gets first_send_ts
getGroupId() : string|null: Gets group_id
getGroupName() : string|null: Gets group_name
getHoursToCompleteEnd() : string|null: Gets hours_to_complete_end
getHoursToCompleteStart() : string|null: Gets hours_to_complete_start
getIdChecksAttempted() : string|null: Gets id_checks_attempted
getIdChecksFailed() : string|null: Gets id_checks_failed
getIdCountry() : string|null: Gets id_country
getIdMethod() : string|null: Gets id_method
getInitialSendTs() : string|null: Gets initial_send_ts
getIpAddress() : string|null: Gets ip_address
getLastActivity() : string|null: Gets last_activity
getLastActivityDate() : string|null: Gets last_activity_date
getLastModified() : string|null: Gets last_modified
getLastSentDate() : string|null: Gets last_sent_date
getLastUsed() : string|null: Gets last_used
getMetadataRemoved() : string|null: Gets metadata_removed
getModelName() : string: The original name of the model.
getNotSigned() : string|null: Gets not_signed
getNumberOfAuthenticatedRecipients() : string|null: Gets number_of_authenticated_recipients
getNumberOfCompletedSignatures() : string|null: Gets number_of_completed_signatures
getNumberOfDocuments() : string|null: Gets number_of_documents
getNumberOfPages() : string|null: Gets number_of_pages
getNumberOfRecipients() : string|null: Gets number_of_recipients
getNumberOfSends() : string|null: Gets number_of_sends
getNumberOfSigners() : string|null: Gets number_of_signers
getNumberOfTotalDocuments() : string|null: Gets number_of_total_documents
getNumberOfTotalPages() : string|null: Gets number_of_total_pages
getNumberOfTotalSigners() : string|null: Gets number_of_total_signers
getNumberOfUniqueSenders() : string|null: Gets number_of_unique_senders
getNumberTotalRecipients() : string|null: Gets number_total_recipients
getOtherRecipientsList() : string|null: Gets other_recipients_list
getOwner() : string|null: Gets owner
getOwnerMail() : string|null: Gets owner_mail
getPeriodEnd() : string|null: Gets period_end
getPeriodStart() : string|null: Gets period_start
getPhoneCallsAttempted() : string|null: Gets phone_calls_attempted
getPhoneCallsFailed() : string|null: Gets phone_calls_failed
getPiiRedacted() : string|null: Gets pii_redacted
getPurgeDate() : string|null: Gets purge_date
getReasonForDeclining() : string|null: Gets reason_for_declining
getReasonForVoiding() : string|null: Gets reason_for_voiding
getReassignReason() : string|null: Gets reassign_reason
getReceived() : string|null: Gets received
getRecipient() : string|null: Gets recipient
getRecipientAction() : string|null: Gets recipient_action
getRecipientCompanyName() : string|null: Gets recipient_company_name
getRecipientCountry() : string|null: Gets recipient_country
getRecipientEmail() : string|null: Gets recipient_email
getRecipientId() : string|null: Gets recipient_id
getRecipientName() : string|null: Gets recipient_name
getRecipientRoleName() : string|null: Gets recipient_role_name
getRecipientTemplateRoleName() : string|null: Gets recipient_template_role_name
getRecipientTitle() : string|null: Gets recipient_title
getRecipientType() : string|null: Gets recipient_type
getRecipientUserId() : string|null: Gets recipient_user_id
getRemainingSignatures() : string|null: Gets remaining_signatures
getRoutingOrder() : string|null: Gets routing_order
getSenderAccountId() : string|null: Gets sender_account_id
getSenderCompanyName() : string|null: Gets sender_company_name
getSenderCountry() : string|null: Gets sender_country
getSenderEmail() : string|null: Gets sender_email
getSenderIpAddress() : string|null: Gets sender_ip_address
getSenderJobTitle() : string|null: Gets sender_job_title
getSenderName() : string|null: Gets sender_name
getSenderUserId() : string|null: Gets sender_user_id
getSignatureType() : string|null: Gets signature_type
getSignatureTypeValue() : string|null: Gets signature_type_value
getSignDate() : string|null: Gets sign_date
getSigned() : string|null: Gets signed
getSignedDate() : string|null: Gets signed_date
getSignedOnMobile() : string|null: Gets signed_on_mobile
getSignedOnPaper() : string|null: Gets signed_on_paper
getSignerList() : string|null: Gets signer_list
getStatus() : string|null: Gets status
getStatusChangedDate() : string|null: Gets status_changed_date
getStatusChangedTs() : string|null: Gets status_changed_ts
getStatusComment() : string|null: Gets status_comment
getSubject() : string|null: Gets subject
getSuccesses() : string|null: Gets successes
getTemplateId() : string|null: Gets template_id
getTemplateName() : string|null: Gets template_name
getTemplatesCreated() : string|null: Gets templates_created
getTemplatesCreatedCount() : string|null: Gets templates_created_count
getTerminalStatusDate() : string|null: Gets terminal_status_date
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
getTimeToCompleteSeconds() : string|null: Gets time_to_complete_seconds
getTimeToDeliver() : string|null: Gets time_to_deliver
getTotalDocuments() : string|null: Gets total_documents
getTotalEnvelopes() : string|null: Gets total_envelopes
getTotalPages() : string|null: Gets total_pages
getTotalRecipients() : string|null: Gets total_recipients
getTotalSigners() : string|null: Gets total_signers
getUniqueSenders() : string|null: Gets unique_senders
getUserAccountEmail() : string|null: Gets user_account_email
getUserAccountName() : string|null: Gets user_account_name
getUserAccountStatus() : string|null: Gets user_account_status
getUserCount() : string|null: Gets user_count
getUserId() : string|null: Gets user_id
getVerificationStatus() : string|null: Gets verification_status
getVerificationType() : string|null: Gets verification_type
getViewDate() : string|null: Gets view_date
getVoidedTs() : string|null: Gets voided_ts
listInvalidProperties() : array<string|int, mixed>: Show all the invalid properties with reasons.
offsetExists() : bool: Returns true if offset exists. False otherwise.
offsetGet() : mixed: Gets offset.
offsetSet() : void: Sets value based on offset.
offsetUnset() : void: Unsets offset.
setAccessCodeRequired() : $this: Sets access_code_required
setAccessCodesAttempted() : $this: Sets access_codes_attempted
setAccessCodesFailed() : $this: Sets access_codes_failed
setAccountId() : $this: Sets account_id
setAuthenticationCategory() : $this: Sets authentication_category
setAuthenticationSuccess() : $this: Sets authentication_success
setAuthenticationType() : $this: Sets authentication_type
setAverageTimeToCompleteSeconds() : $this: Sets average_time_to_complete_seconds
setAvgCompleteSeconds() : $this: Sets avg_complete_seconds
setCaptureMethod() : $this: Sets capture_method
setCompleted() : $this: Sets completed
setCompletedTs() : $this: Sets completed_ts
setCreatedDate() : $this: Sets created_date
setCreatedOn() : $this: Sets created_on
setCreator() : $this: Sets creator
setCustomField() : $this: Sets custom_field
setDeclinedDate() : $this: Sets declined_date
setDeclinedReason() : $this: Sets declined_reason
setDeliveredDate() : $this: Sets delivered_date
setEnvelopeCount() : $this: Sets envelope_count
setEnvelopeCreator() : $this: Sets envelope_creator
setEnvelopeId() : $this: Sets envelope_id
setEnvelopeInitialSendTs() : $this: Sets envelope_initial_send_ts
setEnvelopesBilled() : $this: Sets envelopes_billed
setEnvelopesCompleted() : $this: Sets envelopes_completed
setEnvelopesCompletedCount() : $this: Sets envelopes_completed_count
setEnvelopesDeclined() : $this: Sets envelopes_declined
setEnvelopesSent() : $this: Sets envelopes_sent
setEnvelopesSentCount() : $this: Sets envelopes_sent_count
setEnvelopesVoided() : $this: Sets envelopes_voided
setEnvelopeVoidedReason() : $this: Sets envelope_voided_reason
setEodDocumentDescription() : $this: Sets eod_document_description
setEodDocumentName() : $this: Sets eod_document_name
setEodDocumentProfileId() : $this: Sets eod_document_profile_id
setEodTransactionId() : $this: Sets eod_transaction_id
setEodTransactionName() : $this: Sets eod_transaction_name
setEventDate() : $this: Sets event_date
setExpirationDate() : $this: Sets expiration_date
setExpiredTs() : $this: Sets expired_ts
setFailureReason() : $this: Sets failure_reason
setFailures() : $this: Sets failures
setFailureVendorCode() : $this: Sets failure_vendor_code
setFailureVendorReason() : $this: Sets failure_vendor_reason
setFirstSendTs() : $this: Sets first_send_ts
setGroupId() : $this: Sets group_id
setGroupName() : $this: Sets group_name
setHoursToCompleteEnd() : $this: Sets hours_to_complete_end
setHoursToCompleteStart() : $this: Sets hours_to_complete_start
setIdChecksAttempted() : $this: Sets id_checks_attempted
setIdChecksFailed() : $this: Sets id_checks_failed
setIdCountry() : $this: Sets id_country
setIdMethod() : $this: Sets id_method
setInitialSendTs() : $this: Sets initial_send_ts
setIpAddress() : $this: Sets ip_address
setLastActivity() : $this: Sets last_activity
setLastActivityDate() : $this: Sets last_activity_date
setLastModified() : $this: Sets last_modified
setLastSentDate() : $this: Sets last_sent_date
setLastUsed() : $this: Sets last_used
setMetadataRemoved() : $this: Sets metadata_removed
setNotSigned() : $this: Sets not_signed
setNumberOfAuthenticatedRecipients() : $this: Sets number_of_authenticated_recipients
setNumberOfCompletedSignatures() : $this: Sets number_of_completed_signatures
setNumberOfDocuments() : $this: Sets number_of_documents
setNumberOfPages() : $this: Sets number_of_pages
setNumberOfRecipients() : $this: Sets number_of_recipients
setNumberOfSends() : $this: Sets number_of_sends
setNumberOfSigners() : $this: Sets number_of_signers
setNumberOfTotalDocuments() : $this: Sets number_of_total_documents
setNumberOfTotalPages() : $this: Sets number_of_total_pages
setNumberOfTotalSigners() : $this: Sets number_of_total_signers
setNumberOfUniqueSenders() : $this: Sets number_of_unique_senders
setNumberTotalRecipients() : $this: Sets number_total_recipients
setOtherRecipientsList() : $this: Sets other_recipients_list
setOwner() : $this: Sets owner
setOwnerMail() : $this: Sets owner_mail
setPeriodEnd() : $this: Sets period_end
setPeriodStart() : $this: Sets period_start
setPhoneCallsAttempted() : $this: Sets phone_calls_attempted
setPhoneCallsFailed() : $this: Sets phone_calls_failed
setPiiRedacted() : $this: Sets pii_redacted
setPurgeDate() : $this: Sets purge_date
setReasonForDeclining() : $this: Sets reason_for_declining
setReasonForVoiding() : $this: Sets reason_for_voiding
setReassignReason() : $this: Sets reassign_reason
setReceived() : $this: Sets received
setRecipient() : $this: Sets recipient
setRecipientAction() : $this: Sets recipient_action
setRecipientCompanyName() : $this: Sets recipient_company_name
setRecipientCountry() : $this: Sets recipient_country
setRecipientEmail() : $this: Sets recipient_email
setRecipientId() : $this: Sets recipient_id
setRecipientName() : $this: Sets recipient_name
setRecipientRoleName() : $this: Sets recipient_role_name
setRecipientTemplateRoleName() : $this: Sets recipient_template_role_name
setRecipientTitle() : $this: Sets recipient_title
setRecipientType() : $this: Sets recipient_type
setRecipientUserId() : $this: Sets recipient_user_id
setRemainingSignatures() : $this: Sets remaining_signatures
setRoutingOrder() : $this: Sets routing_order
setSenderAccountId() : $this: Sets sender_account_id
setSenderCompanyName() : $this: Sets sender_company_name
setSenderCountry() : $this: Sets sender_country
setSenderEmail() : $this: Sets sender_email
setSenderIpAddress() : $this: Sets sender_ip_address
setSenderJobTitle() : $this: Sets sender_job_title
setSenderName() : $this: Sets sender_name
setSenderUserId() : $this: Sets sender_user_id
setSignatureType() : $this: Sets signature_type
setSignatureTypeValue() : $this: Sets signature_type_value
setSignDate() : $this: Sets sign_date
setSigned() : $this: Sets signed
setSignedDate() : $this: Sets signed_date
setSignedOnMobile() : $this: Sets signed_on_mobile
setSignedOnPaper() : $this: Sets signed_on_paper
setSignerList() : $this: Sets signer_list
setStatus() : $this: Sets status
setStatusChangedDate() : $this: Sets status_changed_date
setStatusChangedTs() : $this: Sets status_changed_ts
setStatusComment() : $this: Sets status_comment
setSubject() : $this: Sets subject
setSuccesses() : $this: Sets successes
setTemplateId() : $this: Sets template_id
setTemplateName() : $this: Sets template_name
setTemplatesCreated() : $this: Sets templates_created
setTemplatesCreatedCount() : $this: Sets templates_created_count
setTerminalStatusDate() : $this: Sets terminal_status_date
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
setTimeToCompleteSeconds() : $this: Sets time_to_complete_seconds
setTimeToDeliver() : $this: Sets time_to_deliver
setTotalDocuments() : $this: Sets total_documents
setTotalEnvelopes() : $this: Sets total_envelopes
setTotalPages() : $this: Sets total_pages
setTotalRecipients() : $this: Sets total_recipients
setTotalSigners() : $this: Sets total_signers
setUniqueSenders() : $this: Sets unique_senders
setUserAccountEmail() : $this: Sets user_account_email
setUserAccountName() : $this: Sets user_account_name
setUserAccountStatus() : $this: Sets user_account_status
setUserCount() : $this: Sets user_count
setUserId() : $this: Sets user_id
setVerificationStatus() : $this: Sets verification_status
setVerificationType() : $this: Sets verification_type
setViewDate() : $this: Sets view_date
setVoidedTs() : $this: Sets voided_ts
swaggerFormats() : array<string|int, mixed>: Array of property to format mappings. Used for (de)serialization
swaggerTypes() : array<string|int, mixed>: Array of property to type mappings. Used for (de)serialization
valid() : bool: Validate all the properties in the model return true if all passed

DISCRIMINATOR


    public
        mixed
    DISCRIMINATOR
    = null

$attributeMap

Array of attributes where the key is the local name, and the value is the original name


    protected
    static    array<string|int, string>
    $attributeMap
     = ['access_code_required' => 'accessCodeRequired', 'access_codes_attempted' => 'accessCodesAttempted', 'access_codes_failed' => 'accessCodesFailed', 'account_id' => 'accountId', 'authentication_category' => 'authenticationCategory', 'authentication_success' => 'authenticationSuccess', 'authentication_type' => 'authenticationType', 'average_time_to_complete_seconds' => 'averageTimeToCompleteSeconds', 'avg_complete_seconds' => 'avgCompleteSeconds', 'capture_method' => 'captureMethod', 'completed' => 'completed', 'completed_ts' => 'completedTs', 'created_date' => 'createdDate', 'created_on' => 'createdOn', 'creator' => 'creator', 'custom_field' => 'customField', 'declined_date' => 'declinedDate', 'declined_reason' => 'declinedReason', 'delivered_date' => 'deliveredDate', 'envelope_count' => 'envelopeCount', 'envelope_creator' => 'envelopeCreator', 'envelope_id' => 'envelopeId', 'envelope_initial_send_ts' => 'envelopeInitialSendTs', 'envelopes_billed' => 'envelopesBilled', 'envelopes_completed' => 'envelopesCompleted', 'envelopes_completed_count' => 'envelopesCompletedCount', 'envelopes_declined' => 'envelopesDeclined', 'envelopes_sent' => 'envelopesSent', 'envelopes_sent_count' => 'envelopesSentCount', 'envelopes_voided' => 'envelopesVoided', 'envelope_voided_reason' => 'envelopeVoidedReason', 'eod_document_description' => 'eodDocumentDescription', 'eod_document_name' => 'eodDocumentName', 'eod_document_profile_id' => 'eodDocumentProfileId', 'eod_transaction_id' => 'eodTransactionId', 'eod_transaction_name' => 'eodTransactionName', 'event_date' => 'eventDate', 'expiration_date' => 'expirationDate', 'expired_ts' => 'expiredTs', 'failure_reason' => 'failureReason', 'failures' => 'failures', 'failure_vendor_code' => 'failureVendorCode', 'failure_vendor_reason' => 'failureVendorReason', 'first_send_ts' => 'firstSendTs', 'group_id' => 'groupId', 'group_name' => 'groupName', 'hours_to_complete_end' => 'hoursToCompleteEnd', 'hours_to_complete_start' => 'hoursToCompleteStart', 'id_checks_attempted' => 'idChecksAttempted', 'id_checks_failed' => 'idChecksFailed', 'id_country' => 'idCountry', 'id_method' => 'idMethod', 'initial_send_ts' => 'initialSendTs', 'ip_address' => 'ipAddress', 'last_activity' => 'lastActivity', 'last_activity_date' => 'lastActivityDate', 'last_modified' => 'lastModified', 'last_sent_date' => 'lastSentDate', 'last_used' => 'lastUsed', 'metadata_removed' => 'metadataRemoved', 'not_signed' => 'notSigned', 'number_of_authenticated_recipients' => 'numberOfAuthenticatedRecipients', 'number_of_completed_signatures' => 'numberOfCompletedSignatures', 'number_of_documents' => 'numberOfDocuments', 'number_of_pages' => 'numberOfPages', 'number_of_recipients' => 'numberOfRecipients', 'number_of_sends' => 'numberOfSends', 'number_of_signers' => 'numberOfSigners', 'number_of_total_documents' => 'numberOfTotalDocuments', 'number_of_total_pages' => 'numberOfTotalPages', 'number_of_total_signers' => 'numberOfTotalSigners', 'number_of_unique_senders' => 'numberOfUniqueSenders', 'number_total_recipients' => 'numberTotalRecipients', 'other_recipients_list' => 'otherRecipientsList', 'owner' => 'owner', 'owner_mail' => 'ownerMail', 'period_end' => 'periodEnd', 'period_start' => 'periodStart', 'phone_calls_attempted' => 'phoneCallsAttempted', 'phone_calls_failed' => 'phoneCallsFailed', 'pii_redacted' => 'piiRedacted', 'purge_date' => 'purgeDate', 'reason_for_declining' => 'reasonForDeclining', 'reason_for_voiding' => 'reasonForVoiding', 'reassign_reason' => 'reassignReason', 'received' => 'received', 'recipient' => 'recipient', 'recipient_action' => 'recipientAction', 'recipient_company_name' => 'recipientCompanyName', 'recipient_country' => 'recipientCountry', 'recipient_email' => 'recipientEmail', 'recipient_id' => 'recipientId', 'recipient_name' => 'recipientName', 'recipient_role_name' => 'recipientRoleName', 'recipient_template_role_name' => 'recipientTemplateRoleName', 'recipient_title' => 'recipientTitle', 'recipient_type' => 'recipientType', 'recipient_user_id' => 'recipientUserId', 'remaining_signatures' => 'remainingSignatures', 'routing_order' => 'routingOrder', 'sender_account_id' => 'senderAccountId', 'sender_company_name' => 'senderCompanyName', 'sender_country' => 'senderCountry', 'sender_email' => 'senderEmail', 'sender_ip_address' => 'senderIPAddress', 'sender_job_title' => 'senderJobTitle', 'sender_name' => 'senderName', 'sender_user_id' => 'senderUserId', 'signature_type' => 'signatureType', 'signature_type_value' => 'signatureTypeValue', 'sign_date' => 'signDate', 'signed' => 'signed', 'signed_date' => 'signedDate', 'signed_on_mobile' => 'signedOnMobile', 'signed_on_paper' => 'signedOnPaper', 'signer_list' => 'signerList', 'status' => 'status', 'status_changed_date' => 'statusChangedDate', 'status_changed_ts' => 'statusChangedTs', 'status_comment' => 'statusComment', 'subject' => 'subject', 'successes' => 'successes', 'template_id' => 'templateId', 'template_name' => 'templateName', 'templates_created' => 'templatesCreated', 'templates_created_count' => 'templatesCreatedCount', 'terminal_status_date' => 'terminalStatusDate', 'time_to_complete_seconds' => 'timeToCompleteSeconds', 'time_to_deliver' => 'timeToDeliver', 'total_documents' => 'totalDocuments', 'total_envelopes' => 'totalEnvelopes', 'total_pages' => 'totalPages', 'total_recipients' => 'totalRecipients', 'total_signers' => 'totalSigners', 'unique_senders' => 'uniqueSenders', 'user_account_email' => 'userAccountEmail', 'user_account_name' => 'userAccountName', 'user_account_status' => 'userAccountStatus', 'user_count' => 'userCount', 'user_id' => 'userId', 'verification_status' => 'verificationStatus', 'verification_type' => 'verificationType', 'view_date' => 'viewDate', 'voided_ts' => 'voidedTs']

$container

Associative array for storing property values


    protected
        array<string|int, mixed>
    $container
     = []

$getters

Array of attributes to getter functions (for serialization of requests)


    protected
    static    array<string|int, string>
    $getters
     = ['access_code_required' => 'getAccessCodeRequired', 'access_codes_attempted' => 'getAccessCodesAttempted', 'access_codes_failed' => 'getAccessCodesFailed', 'account_id' => 'getAccountId', 'authentication_category' => 'getAuthenticationCategory', 'authentication_success' => 'getAuthenticationSuccess', 'authentication_type' => 'getAuthenticationType', 'average_time_to_complete_seconds' => 'getAverageTimeToCompleteSeconds', 'avg_complete_seconds' => 'getAvgCompleteSeconds', 'capture_method' => 'getCaptureMethod', 'completed' => 'getCompleted', 'completed_ts' => 'getCompletedTs', 'created_date' => 'getCreatedDate', 'created_on' => 'getCreatedOn', 'creator' => 'getCreator', 'custom_field' => 'getCustomField', 'declined_date' => 'getDeclinedDate', 'declined_reason' => 'getDeclinedReason', 'delivered_date' => 'getDeliveredDate', 'envelope_count' => 'getEnvelopeCount', 'envelope_creator' => 'getEnvelopeCreator', 'envelope_id' => 'getEnvelopeId', 'envelope_initial_send_ts' => 'getEnvelopeInitialSendTs', 'envelopes_billed' => 'getEnvelopesBilled', 'envelopes_completed' => 'getEnvelopesCompleted', 'envelopes_completed_count' => 'getEnvelopesCompletedCount', 'envelopes_declined' => 'getEnvelopesDeclined', 'envelopes_sent' => 'getEnvelopesSent', 'envelopes_sent_count' => 'getEnvelopesSentCount', 'envelopes_voided' => 'getEnvelopesVoided', 'envelope_voided_reason' => 'getEnvelopeVoidedReason', 'eod_document_description' => 'getEodDocumentDescription', 'eod_document_name' => 'getEodDocumentName', 'eod_document_profile_id' => 'getEodDocumentProfileId', 'eod_transaction_id' => 'getEodTransactionId', 'eod_transaction_name' => 'getEodTransactionName', 'event_date' => 'getEventDate', 'expiration_date' => 'getExpirationDate', 'expired_ts' => 'getExpiredTs', 'failure_reason' => 'getFailureReason', 'failures' => 'getFailures', 'failure_vendor_code' => 'getFailureVendorCode', 'failure_vendor_reason' => 'getFailureVendorReason', 'first_send_ts' => 'getFirstSendTs', 'group_id' => 'getGroupId', 'group_name' => 'getGroupName', 'hours_to_complete_end' => 'getHoursToCompleteEnd', 'hours_to_complete_start' => 'getHoursToCompleteStart', 'id_checks_attempted' => 'getIdChecksAttempted', 'id_checks_failed' => 'getIdChecksFailed', 'id_country' => 'getIdCountry', 'id_method' => 'getIdMethod', 'initial_send_ts' => 'getInitialSendTs', 'ip_address' => 'getIpAddress', 'last_activity' => 'getLastActivity', 'last_activity_date' => 'getLastActivityDate', 'last_modified' => 'getLastModified', 'last_sent_date' => 'getLastSentDate', 'last_used' => 'getLastUsed', 'metadata_removed' => 'getMetadataRemoved', 'not_signed' => 'getNotSigned', 'number_of_authenticated_recipients' => 'getNumberOfAuthenticatedRecipients', 'number_of_completed_signatures' => 'getNumberOfCompletedSignatures', 'number_of_documents' => 'getNumberOfDocuments', 'number_of_pages' => 'getNumberOfPages', 'number_of_recipients' => 'getNumberOfRecipients', 'number_of_sends' => 'getNumberOfSends', 'number_of_signers' => 'getNumberOfSigners', 'number_of_total_documents' => 'getNumberOfTotalDocuments', 'number_of_total_pages' => 'getNumberOfTotalPages', 'number_of_total_signers' => 'getNumberOfTotalSigners', 'number_of_unique_senders' => 'getNumberOfUniqueSenders', 'number_total_recipients' => 'getNumberTotalRecipients', 'other_recipients_list' => 'getOtherRecipientsList', 'owner' => 'getOwner', 'owner_mail' => 'getOwnerMail', 'period_end' => 'getPeriodEnd', 'period_start' => 'getPeriodStart', 'phone_calls_attempted' => 'getPhoneCallsAttempted', 'phone_calls_failed' => 'getPhoneCallsFailed', 'pii_redacted' => 'getPiiRedacted', 'purge_date' => 'getPurgeDate', 'reason_for_declining' => 'getReasonForDeclining', 'reason_for_voiding' => 'getReasonForVoiding', 'reassign_reason' => 'getReassignReason', 'received' => 'getReceived', 'recipient' => 'getRecipient', 'recipient_action' => 'getRecipientAction', 'recipient_company_name' => 'getRecipientCompanyName', 'recipient_country' => 'getRecipientCountry', 'recipient_email' => 'getRecipientEmail', 'recipient_id' => 'getRecipientId', 'recipient_name' => 'getRecipientName', 'recipient_role_name' => 'getRecipientRoleName', 'recipient_template_role_name' => 'getRecipientTemplateRoleName', 'recipient_title' => 'getRecipientTitle', 'recipient_type' => 'getRecipientType', 'recipient_user_id' => 'getRecipientUserId', 'remaining_signatures' => 'getRemainingSignatures', 'routing_order' => 'getRoutingOrder', 'sender_account_id' => 'getSenderAccountId', 'sender_company_name' => 'getSenderCompanyName', 'sender_country' => 'getSenderCountry', 'sender_email' => 'getSenderEmail', 'sender_ip_address' => 'getSenderIpAddress', 'sender_job_title' => 'getSenderJobTitle', 'sender_name' => 'getSenderName', 'sender_user_id' => 'getSenderUserId', 'signature_type' => 'getSignatureType', 'signature_type_value' => 'getSignatureTypeValue', 'sign_date' => 'getSignDate', 'signed' => 'getSigned', 'signed_date' => 'getSignedDate', 'signed_on_mobile' => 'getSignedOnMobile', 'signed_on_paper' => 'getSignedOnPaper', 'signer_list' => 'getSignerList', 'status' => 'getStatus', 'status_changed_date' => 'getStatusChangedDate', 'status_changed_ts' => 'getStatusChangedTs', 'status_comment' => 'getStatusComment', 'subject' => 'getSubject', 'successes' => 'getSuccesses', 'template_id' => 'getTemplateId', 'template_name' => 'getTemplateName', 'templates_created' => 'getTemplatesCreated', 'templates_created_count' => 'getTemplatesCreatedCount', 'terminal_status_date' => 'getTerminalStatusDate', 'time_to_complete_seconds' => 'getTimeToCompleteSeconds', 'time_to_deliver' => 'getTimeToDeliver', 'total_documents' => 'getTotalDocuments', 'total_envelopes' => 'getTotalEnvelopes', 'total_pages' => 'getTotalPages', 'total_recipients' => 'getTotalRecipients', 'total_signers' => 'getTotalSigners', 'unique_senders' => 'getUniqueSenders', 'user_account_email' => 'getUserAccountEmail', 'user_account_name' => 'getUserAccountName', 'user_account_status' => 'getUserAccountStatus', 'user_count' => 'getUserCount', 'user_id' => 'getUserId', 'verification_status' => 'getVerificationStatus', 'verification_type' => 'getVerificationType', 'view_date' => 'getViewDate', 'voided_ts' => 'getVoidedTs']

$setters

Array of attributes to setter functions (for deserialization of responses)


    protected
    static    array<string|int, string>
    $setters
     = ['access_code_required' => 'setAccessCodeRequired', 'access_codes_attempted' => 'setAccessCodesAttempted', 'access_codes_failed' => 'setAccessCodesFailed', 'account_id' => 'setAccountId', 'authentication_category' => 'setAuthenticationCategory', 'authentication_success' => 'setAuthenticationSuccess', 'authentication_type' => 'setAuthenticationType', 'average_time_to_complete_seconds' => 'setAverageTimeToCompleteSeconds', 'avg_complete_seconds' => 'setAvgCompleteSeconds', 'capture_method' => 'setCaptureMethod', 'completed' => 'setCompleted', 'completed_ts' => 'setCompletedTs', 'created_date' => 'setCreatedDate', 'created_on' => 'setCreatedOn', 'creator' => 'setCreator', 'custom_field' => 'setCustomField', 'declined_date' => 'setDeclinedDate', 'declined_reason' => 'setDeclinedReason', 'delivered_date' => 'setDeliveredDate', 'envelope_count' => 'setEnvelopeCount', 'envelope_creator' => 'setEnvelopeCreator', 'envelope_id' => 'setEnvelopeId', 'envelope_initial_send_ts' => 'setEnvelopeInitialSendTs', 'envelopes_billed' => 'setEnvelopesBilled', 'envelopes_completed' => 'setEnvelopesCompleted', 'envelopes_completed_count' => 'setEnvelopesCompletedCount', 'envelopes_declined' => 'setEnvelopesDeclined', 'envelopes_sent' => 'setEnvelopesSent', 'envelopes_sent_count' => 'setEnvelopesSentCount', 'envelopes_voided' => 'setEnvelopesVoided', 'envelope_voided_reason' => 'setEnvelopeVoidedReason', 'eod_document_description' => 'setEodDocumentDescription', 'eod_document_name' => 'setEodDocumentName', 'eod_document_profile_id' => 'setEodDocumentProfileId', 'eod_transaction_id' => 'setEodTransactionId', 'eod_transaction_name' => 'setEodTransactionName', 'event_date' => 'setEventDate', 'expiration_date' => 'setExpirationDate', 'expired_ts' => 'setExpiredTs', 'failure_reason' => 'setFailureReason', 'failures' => 'setFailures', 'failure_vendor_code' => 'setFailureVendorCode', 'failure_vendor_reason' => 'setFailureVendorReason', 'first_send_ts' => 'setFirstSendTs', 'group_id' => 'setGroupId', 'group_name' => 'setGroupName', 'hours_to_complete_end' => 'setHoursToCompleteEnd', 'hours_to_complete_start' => 'setHoursToCompleteStart', 'id_checks_attempted' => 'setIdChecksAttempted', 'id_checks_failed' => 'setIdChecksFailed', 'id_country' => 'setIdCountry', 'id_method' => 'setIdMethod', 'initial_send_ts' => 'setInitialSendTs', 'ip_address' => 'setIpAddress', 'last_activity' => 'setLastActivity', 'last_activity_date' => 'setLastActivityDate', 'last_modified' => 'setLastModified', 'last_sent_date' => 'setLastSentDate', 'last_used' => 'setLastUsed', 'metadata_removed' => 'setMetadataRemoved', 'not_signed' => 'setNotSigned', 'number_of_authenticated_recipients' => 'setNumberOfAuthenticatedRecipients', 'number_of_completed_signatures' => 'setNumberOfCompletedSignatures', 'number_of_documents' => 'setNumberOfDocuments', 'number_of_pages' => 'setNumberOfPages', 'number_of_recipients' => 'setNumberOfRecipients', 'number_of_sends' => 'setNumberOfSends', 'number_of_signers' => 'setNumberOfSigners', 'number_of_total_documents' => 'setNumberOfTotalDocuments', 'number_of_total_pages' => 'setNumberOfTotalPages', 'number_of_total_signers' => 'setNumberOfTotalSigners', 'number_of_unique_senders' => 'setNumberOfUniqueSenders', 'number_total_recipients' => 'setNumberTotalRecipients', 'other_recipients_list' => 'setOtherRecipientsList', 'owner' => 'setOwner', 'owner_mail' => 'setOwnerMail', 'period_end' => 'setPeriodEnd', 'period_start' => 'setPeriodStart', 'phone_calls_attempted' => 'setPhoneCallsAttempted', 'phone_calls_failed' => 'setPhoneCallsFailed', 'pii_redacted' => 'setPiiRedacted', 'purge_date' => 'setPurgeDate', 'reason_for_declining' => 'setReasonForDeclining', 'reason_for_voiding' => 'setReasonForVoiding', 'reassign_reason' => 'setReassignReason', 'received' => 'setReceived', 'recipient' => 'setRecipient', 'recipient_action' => 'setRecipientAction', 'recipient_company_name' => 'setRecipientCompanyName', 'recipient_country' => 'setRecipientCountry', 'recipient_email' => 'setRecipientEmail', 'recipient_id' => 'setRecipientId', 'recipient_name' => 'setRecipientName', 'recipient_role_name' => 'setRecipientRoleName', 'recipient_template_role_name' => 'setRecipientTemplateRoleName', 'recipient_title' => 'setRecipientTitle', 'recipient_type' => 'setRecipientType', 'recipient_user_id' => 'setRecipientUserId', 'remaining_signatures' => 'setRemainingSignatures', 'routing_order' => 'setRoutingOrder', 'sender_account_id' => 'setSenderAccountId', 'sender_company_name' => 'setSenderCompanyName', 'sender_country' => 'setSenderCountry', 'sender_email' => 'setSenderEmail', 'sender_ip_address' => 'setSenderIpAddress', 'sender_job_title' => 'setSenderJobTitle', 'sender_name' => 'setSenderName', 'sender_user_id' => 'setSenderUserId', 'signature_type' => 'setSignatureType', 'signature_type_value' => 'setSignatureTypeValue', 'sign_date' => 'setSignDate', 'signed' => 'setSigned', 'signed_date' => 'setSignedDate', 'signed_on_mobile' => 'setSignedOnMobile', 'signed_on_paper' => 'setSignedOnPaper', 'signer_list' => 'setSignerList', 'status' => 'setStatus', 'status_changed_date' => 'setStatusChangedDate', 'status_changed_ts' => 'setStatusChangedTs', 'status_comment' => 'setStatusComment', 'subject' => 'setSubject', 'successes' => 'setSuccesses', 'template_id' => 'setTemplateId', 'template_name' => 'setTemplateName', 'templates_created' => 'setTemplatesCreated', 'templates_created_count' => 'setTemplatesCreatedCount', 'terminal_status_date' => 'setTerminalStatusDate', 'time_to_complete_seconds' => 'setTimeToCompleteSeconds', 'time_to_deliver' => 'setTimeToDeliver', 'total_documents' => 'setTotalDocuments', 'total_envelopes' => 'setTotalEnvelopes', 'total_pages' => 'setTotalPages', 'total_recipients' => 'setTotalRecipients', 'total_signers' => 'setTotalSigners', 'unique_senders' => 'setUniqueSenders', 'user_account_email' => 'setUserAccountEmail', 'user_account_name' => 'setUserAccountName', 'user_account_status' => 'setUserAccountStatus', 'user_count' => 'setUserCount', 'user_id' => 'setUserId', 'verification_status' => 'setVerificationStatus', 'verification_type' => 'setVerificationType', 'view_date' => 'setViewDate', 'voided_ts' => 'setVoidedTs']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization


    protected
    static    array<string|int, string>
    $swaggerFormats
     = ['access_code_required' => null, 'access_codes_attempted' => null, 'access_codes_failed' => null, 'account_id' => null, 'authentication_category' => null, 'authentication_success' => null, 'authentication_type' => null, 'average_time_to_complete_seconds' => null, 'avg_complete_seconds' => null, 'capture_method' => null, 'completed' => null, 'completed_ts' => null, 'created_date' => null, 'created_on' => null, 'creator' => null, 'custom_field' => null, 'declined_date' => null, 'declined_reason' => null, 'delivered_date' => null, 'envelope_count' => null, 'envelope_creator' => null, 'envelope_id' => null, 'envelope_initial_send_ts' => null, 'envelopes_billed' => null, 'envelopes_completed' => null, 'envelopes_completed_count' => null, 'envelopes_declined' => null, 'envelopes_sent' => null, 'envelopes_sent_count' => null, 'envelopes_voided' => null, 'envelope_voided_reason' => null, 'eod_document_description' => null, 'eod_document_name' => null, 'eod_document_profile_id' => null, 'eod_transaction_id' => null, 'eod_transaction_name' => null, 'event_date' => null, 'expiration_date' => null, 'expired_ts' => null, 'failure_reason' => null, 'failures' => null, 'failure_vendor_code' => null, 'failure_vendor_reason' => null, 'first_send_ts' => null, 'group_id' => null, 'group_name' => null, 'hours_to_complete_end' => null, 'hours_to_complete_start' => null, 'id_checks_attempted' => null, 'id_checks_failed' => null, 'id_country' => null, 'id_method' => null, 'initial_send_ts' => null, 'ip_address' => null, 'last_activity' => null, 'last_activity_date' => null, 'last_modified' => null, 'last_sent_date' => null, 'last_used' => null, 'metadata_removed' => null, 'not_signed' => null, 'number_of_authenticated_recipients' => null, 'number_of_completed_signatures' => null, 'number_of_documents' => null, 'number_of_pages' => null, 'number_of_recipients' => null, 'number_of_sends' => null, 'number_of_signers' => null, 'number_of_total_documents' => null, 'number_of_total_pages' => null, 'number_of_total_signers' => null, 'number_of_unique_senders' => null, 'number_total_recipients' => null, 'other_recipients_list' => null, 'owner' => null, 'owner_mail' => null, 'period_end' => null, 'period_start' => null, 'phone_calls_attempted' => null, 'phone_calls_failed' => null, 'pii_redacted' => null, 'purge_date' => null, 'reason_for_declining' => null, 'reason_for_voiding' => null, 'reassign_reason' => null, 'received' => null, 'recipient' => null, 'recipient_action' => null, 'recipient_company_name' => null, 'recipient_country' => null, 'recipient_email' => null, 'recipient_id' => null, 'recipient_name' => null, 'recipient_role_name' => null, 'recipient_template_role_name' => null, 'recipient_title' => null, 'recipient_type' => null, 'recipient_user_id' => null, 'remaining_signatures' => null, 'routing_order' => null, 'sender_account_id' => null, 'sender_company_name' => null, 'sender_country' => null, 'sender_email' => null, 'sender_ip_address' => null, 'sender_job_title' => null, 'sender_name' => null, 'sender_user_id' => null, 'signature_type' => null, 'signature_type_value' => null, 'sign_date' => null, 'signed' => null, 'signed_date' => null, 'signed_on_mobile' => null, 'signed_on_paper' => null, 'signer_list' => null, 'status' => null, 'status_changed_date' => null, 'status_changed_ts' => null, 'status_comment' => null, 'subject' => null, 'successes' => null, 'template_id' => null, 'template_name' => null, 'templates_created' => null, 'templates_created_count' => null, 'terminal_status_date' => null, 'time_to_complete_seconds' => null, 'time_to_deliver' => null, 'total_documents' => null, 'total_envelopes' => null, 'total_pages' => null, 'total_recipients' => null, 'total_signers' => null, 'unique_senders' => null, 'user_account_email' => null, 'user_account_name' => null, 'user_account_status' => null, 'user_count' => null, 'user_id' => null, 'verification_status' => null, 'verification_type' => null, 'view_date' => null, 'voided_ts' => null]

$swaggerModelName

The original name of the model.


    protected
    static    string
    $swaggerModelName
     = 'reportInProductRunResponseRowFields'

$swaggerTypes

Array of property to type mappings. Used for (de)serialization


    protected
    static    array<string|int, string>
    $swaggerTypes
     = ['access_code_required' => '?string', 'access_codes_attempted' => '?string', 'access_codes_failed' => '?string', 'account_id' => '?string', 'authentication_category' => '?string', 'authentication_success' => '?string', 'authentication_type' => '?string', 'average_time_to_complete_seconds' => '?string', 'avg_complete_seconds' => '?string', 'capture_method' => '?string', 'completed' => '?string', 'completed_ts' => '?string', 'created_date' => '?string', 'created_on' => '?string', 'creator' => '?string', 'custom_field' => '?string', 'declined_date' => '?string', 'declined_reason' => '?string', 'delivered_date' => '?string', 'envelope_count' => '?string', 'envelope_creator' => '?string', 'envelope_id' => '?string', 'envelope_initial_send_ts' => '?string', 'envelopes_billed' => '?string', 'envelopes_completed' => '?string', 'envelopes_completed_count' => '?string', 'envelopes_declined' => '?string', 'envelopes_sent' => '?string', 'envelopes_sent_count' => '?string', 'envelopes_voided' => '?string', 'envelope_voided_reason' => '?string', 'eod_document_description' => '?string', 'eod_document_name' => '?string', 'eod_document_profile_id' => '?string', 'eod_transaction_id' => '?string', 'eod_transaction_name' => '?string', 'event_date' => '?string', 'expiration_date' => '?string', 'expired_ts' => '?string', 'failure_reason' => '?string', 'failures' => '?string', 'failure_vendor_code' => '?string', 'failure_vendor_reason' => '?string', 'first_send_ts' => '?string', 'group_id' => '?string', 'group_name' => '?string', 'hours_to_complete_end' => '?string', 'hours_to_complete_start' => '?string', 'id_checks_attempted' => '?string', 'id_checks_failed' => '?string', 'id_country' => '?string', 'id_method' => '?string', 'initial_send_ts' => '?string', 'ip_address' => '?string', 'last_activity' => '?string', 'last_activity_date' => '?string', 'last_modified' => '?string', 'last_sent_date' => '?string', 'last_used' => '?string', 'metadata_removed' => '?string', 'not_signed' => '?string', 'number_of_authenticated_recipients' => '?string', 'number_of_completed_signatures' => '?string', 'number_of_documents' => '?string', 'number_of_pages' => '?string', 'number_of_recipients' => '?string', 'number_of_sends' => '?string', 'number_of_signers' => '?string', 'number_of_total_documents' => '?string', 'number_of_total_pages' => '?string', 'number_of_total_signers' => '?string', 'number_of_unique_senders' => '?string', 'number_total_recipients' => '?string', 'other_recipients_list' => '?string', 'owner' => '?string', 'owner_mail' => '?string', 'period_end' => '?string', 'period_start' => '?string', 'phone_calls_attempted' => '?string', 'phone_calls_failed' => '?string', 'pii_redacted' => '?string', 'purge_date' => '?string', 'reason_for_declining' => '?string', 'reason_for_voiding' => '?string', 'reassign_reason' => '?string', 'received' => '?string', 'recipient' => '?string', 'recipient_action' => '?string', 'recipient_company_name' => '?string', 'recipient_country' => '?string', 'recipient_email' => '?string', 'recipient_id' => '?string', 'recipient_name' => '?string', 'recipient_role_name' => '?string', 'recipient_template_role_name' => '?string', 'recipient_title' => '?string', 'recipient_type' => '?string', 'recipient_user_id' => '?string', 'remaining_signatures' => '?string', 'routing_order' => '?string', 'sender_account_id' => '?string', 'sender_company_name' => '?string', 'sender_country' => '?string', 'sender_email' => '?string', 'sender_ip_address' => '?string', 'sender_job_title' => '?string', 'sender_name' => '?string', 'sender_user_id' => '?string', 'signature_type' => '?string', 'signature_type_value' => '?string', 'sign_date' => '?string', 'signed' => '?string', 'signed_date' => '?string', 'signed_on_mobile' => '?string', 'signed_on_paper' => '?string', 'signer_list' => '?string', 'status' => '?string', 'status_changed_date' => '?string', 'status_changed_ts' => '?string', 'status_comment' => '?string', 'subject' => '?string', 'successes' => '?string', 'template_id' => '?string', 'template_name' => '?string', 'templates_created' => '?string', 'templates_created_count' => '?string', 'terminal_status_date' => '?string', 'time_to_complete_seconds' => '?string', 'time_to_deliver' => '?string', 'total_documents' => '?string', 'total_envelopes' => '?string', 'total_pages' => '?string', 'total_recipients' => '?string', 'total_signers' => '?string', 'unique_senders' => '?string', 'user_account_email' => '?string', 'user_account_name' => '?string', 'user_account_status' => '?string', 'user_count' => '?string', 'user_id' => '?string', 'verification_status' => '?string', 'verification_type' => '?string', 'view_date' => '?string', 'voided_ts' => '?string']

__construct()

Constructor


    public
                __construct([array<string|int, mixed> $data = null ]) : mixed

Parameters

$data : array<string|int, mixed> = null: Associated array of property values initializing the model

Return values

mixed —

__toString()

Gets the string presentation of the object


    public
                __toString() : string

Return values

string —

attributeMap()

Array of attributes where the key is the local name, and the value is the original name


    public
            static    attributeMap() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getAccessCodeRequired()

Gets access_code_required


    public
                getAccessCodeRequired() : string|null

Return values

string|null —

getAccessCodesAttempted()

Gets access_codes_attempted


    public
                getAccessCodesAttempted() : string|null

Return values

string|null —

getAccessCodesFailed()

Gets access_codes_failed


    public
                getAccessCodesFailed() : string|null

Return values

string|null —

getAccountId()

Gets account_id


    public
                getAccountId() : string|null

Return values

string|null —

getAuthenticationCategory()

Gets authentication_category


    public
                getAuthenticationCategory() : string|null

Return values

string|null —

getAuthenticationSuccess()

Gets authentication_success


    public
                getAuthenticationSuccess() : string|null

Return values

string|null —

getAuthenticationType()

Gets authentication_type


    public
                getAuthenticationType() : string|null

Return values

string|null —

getAverageTimeToCompleteSeconds()

Gets average_time_to_complete_seconds


    public
                getAverageTimeToCompleteSeconds() : string|null

Return values

string|null —

getAvgCompleteSeconds()

Gets avg_complete_seconds


    public
                getAvgCompleteSeconds() : string|null

Return values

string|null —

getCaptureMethod()

Gets capture_method


    public
                getCaptureMethod() : string|null

Return values

string|null —

getCompleted()

Gets completed


    public
                getCompleted() : string|null

Return values

string|null —

getCompletedTs()

Gets completed_ts


    public
                getCompletedTs() : string|null

Return values

string|null —

getCreatedDate()

Gets created_date


    public
                getCreatedDate() : string|null

Return values

string|null —

getCreatedOn()

Gets created_on


    public
                getCreatedOn() : string|null

Return values

string|null —

getCreator()

Gets creator


    public
                getCreator() : string|null

Return values

string|null —

getCustomField()

Gets custom_field


    public
                getCustomField() : string|null

Return values

string|null —

getDeclinedDate()

Gets declined_date


    public
                getDeclinedDate() : string|null

Return values

string|null —

getDeclinedReason()

Gets declined_reason


    public
                getDeclinedReason() : string|null

Return values

string|null —

getDeliveredDate()

Gets delivered_date


    public
                getDeliveredDate() : string|null

Return values

string|null —

getEnvelopeCount()

Gets envelope_count


    public
                getEnvelopeCount() : string|null

Return values

string|null —

getEnvelopeCreator()

Gets envelope_creator


    public
                getEnvelopeCreator() : string|null

Return values

string|null —

getEnvelopeId()

Gets envelope_id


    public
                getEnvelopeId() : string|null

Return values

string|null —

getEnvelopeInitialSendTs()

Gets envelope_initial_send_ts


    public
                getEnvelopeInitialSendTs() : string|null

Return values

string|null —

getEnvelopesBilled()

Gets envelopes_billed


    public
                getEnvelopesBilled() : string|null

Return values

string|null —

getEnvelopesCompleted()

Gets envelopes_completed


    public
                getEnvelopesCompleted() : string|null

Return values

string|null —

getEnvelopesCompletedCount()

Gets envelopes_completed_count


    public
                getEnvelopesCompletedCount() : string|null

Return values

string|null —

getEnvelopesDeclined()

Gets envelopes_declined


    public
                getEnvelopesDeclined() : string|null

Return values

string|null —

getEnvelopesSent()

Gets envelopes_sent


    public
                getEnvelopesSent() : string|null

Return values

string|null —

getEnvelopesSentCount()

Gets envelopes_sent_count


    public
                getEnvelopesSentCount() : string|null

Return values

string|null —

getEnvelopesVoided()

Gets envelopes_voided


    public
                getEnvelopesVoided() : string|null

Return values

string|null —

getEnvelopeVoidedReason()

Gets envelope_voided_reason


    public
                getEnvelopeVoidedReason() : string|null

Return values

string|null —

getEodDocumentDescription()

Gets eod_document_description


    public
                getEodDocumentDescription() : string|null

Return values

string|null —

getEodDocumentName()

Gets eod_document_name


    public
                getEodDocumentName() : string|null

Return values

string|null —

getEodDocumentProfileId()

Gets eod_document_profile_id


    public
                getEodDocumentProfileId() : string|null

Return values

string|null —

getEodTransactionId()

Gets eod_transaction_id


    public
                getEodTransactionId() : string|null

Return values

string|null —

getEodTransactionName()

Gets eod_transaction_name


    public
                getEodTransactionName() : string|null

Return values

string|null —

getEventDate()

Gets event_date


    public
                getEventDate() : string|null

Return values

string|null —

getExpirationDate()

Gets expiration_date


    public
                getExpirationDate() : string|null

Return values

string|null —

getExpiredTs()

Gets expired_ts


    public
                getExpiredTs() : string|null

Return values

string|null —

getFailureReason()

Gets failure_reason


    public
                getFailureReason() : string|null

Return values

string|null —

getFailures()

Gets failures


    public
                getFailures() : string|null

Return values

string|null —

getFailureVendorCode()

Gets failure_vendor_code


    public
                getFailureVendorCode() : string|null

Return values

string|null —

getFailureVendorReason()

Gets failure_vendor_reason


    public
                getFailureVendorReason() : string|null

Return values

string|null —

getFirstSendTs()

Gets first_send_ts


    public
                getFirstSendTs() : string|null

Return values

string|null —

getGroupId()

Gets group_id


    public
                getGroupId() : string|null

Return values

string|null —

getGroupName()

Gets group_name


    public
                getGroupName() : string|null

Return values

string|null —

getHoursToCompleteEnd()

Gets hours_to_complete_end


    public
                getHoursToCompleteEnd() : string|null

Return values

string|null —

getHoursToCompleteStart()

Gets hours_to_complete_start


    public
                getHoursToCompleteStart() : string|null

Return values

string|null —

getIdChecksAttempted()

Gets id_checks_attempted


    public
                getIdChecksAttempted() : string|null

Return values

string|null —

getIdChecksFailed()

Gets id_checks_failed


    public
                getIdChecksFailed() : string|null

Return values

string|null —

getIdCountry()

Gets id_country


    public
                getIdCountry() : string|null

Return values

string|null —

getIdMethod()

Gets id_method


    public
                getIdMethod() : string|null

Return values

string|null —

getInitialSendTs()

Gets initial_send_ts


    public
                getInitialSendTs() : string|null

Return values

string|null —

getIpAddress()

Gets ip_address


    public
                getIpAddress() : string|null

Return values

string|null —

getLastActivity()

Gets last_activity


    public
                getLastActivity() : string|null

Return values

string|null —

getLastActivityDate()

Gets last_activity_date


    public
                getLastActivityDate() : string|null

Return values

string|null —

getLastModified()

Gets last_modified


    public
                getLastModified() : string|null

Return values

string|null —

getLastSentDate()

Gets last_sent_date


    public
                getLastSentDate() : string|null

Return values

string|null —

getLastUsed()

Gets last_used


    public
                getLastUsed() : string|null

Return values

string|null —

getMetadataRemoved()

Gets metadata_removed


    public
                getMetadataRemoved() : string|null

Return values

string|null —

getModelName()

The original name of the model.


    public
                getModelName() : string

Return values

string —

getNotSigned()

Gets not_signed


    public
                getNotSigned() : string|null

Return values

string|null —

getNumberOfAuthenticatedRecipients()

Gets number_of_authenticated_recipients


    public
                getNumberOfAuthenticatedRecipients() : string|null

Return values

string|null —

getNumberOfCompletedSignatures()

Gets number_of_completed_signatures


    public
                getNumberOfCompletedSignatures() : string|null

Return values

string|null —

getNumberOfDocuments()

Gets number_of_documents


    public
                getNumberOfDocuments() : string|null

Return values

string|null —

getNumberOfPages()

Gets number_of_pages


    public
                getNumberOfPages() : string|null

Return values

string|null —

getNumberOfRecipients()

Gets number_of_recipients


    public
                getNumberOfRecipients() : string|null

Return values

string|null —

getNumberOfSends()

Gets number_of_sends


    public
                getNumberOfSends() : string|null

Return values

string|null —

getNumberOfSigners()

Gets number_of_signers


    public
                getNumberOfSigners() : string|null

Return values

string|null —

getNumberOfTotalDocuments()

Gets number_of_total_documents


    public
                getNumberOfTotalDocuments() : string|null

Return values

string|null —

getNumberOfTotalPages()

Gets number_of_total_pages


    public
                getNumberOfTotalPages() : string|null

Return values

string|null —

getNumberOfTotalSigners()

Gets number_of_total_signers


    public
                getNumberOfTotalSigners() : string|null

Return values

string|null —

getNumberOfUniqueSenders()

Gets number_of_unique_senders


    public
                getNumberOfUniqueSenders() : string|null

Return values

string|null —

getNumberTotalRecipients()

Gets number_total_recipients


    public
                getNumberTotalRecipients() : string|null

Return values

string|null —

getOtherRecipientsList()

Gets other_recipients_list


    public
                getOtherRecipientsList() : string|null

Return values

string|null —

getOwner()

Gets owner


    public
                getOwner() : string|null

Return values

string|null —

getOwnerMail()

Gets owner_mail


    public
                getOwnerMail() : string|null

Return values

string|null —

getPeriodEnd()

Gets period_end


    public
                getPeriodEnd() : string|null

Return values

string|null —

getPeriodStart()

Gets period_start


    public
                getPeriodStart() : string|null

Return values

string|null —

getPhoneCallsAttempted()

Gets phone_calls_attempted


    public
                getPhoneCallsAttempted() : string|null

Return values

string|null —

getPhoneCallsFailed()

Gets phone_calls_failed


    public
                getPhoneCallsFailed() : string|null

Return values

string|null —

getPiiRedacted()

Gets pii_redacted


    public
                getPiiRedacted() : string|null

Return values

string|null —

getPurgeDate()

Gets purge_date


    public
                getPurgeDate() : string|null

Return values

string|null —

getReasonForDeclining()

Gets reason_for_declining


    public
                getReasonForDeclining() : string|null

Return values

string|null —

getReasonForVoiding()

Gets reason_for_voiding


    public
                getReasonForVoiding() : string|null

Return values

string|null —

getReassignReason()

Gets reassign_reason


    public
                getReassignReason() : string|null

Return values

string|null —

getReceived()

Gets received


    public
                getReceived() : string|null

Return values

string|null —

getRecipient()

Gets recipient


    public
                getRecipient() : string|null

Return values

string|null —

getRecipientAction()

Gets recipient_action


    public
                getRecipientAction() : string|null

Return values

string|null —

getRecipientCompanyName()

Gets recipient_company_name


    public
                getRecipientCompanyName() : string|null

Return values

string|null —

getRecipientCountry()

Gets recipient_country


    public
                getRecipientCountry() : string|null

Return values

string|null —

getRecipientEmail()

Gets recipient_email


    public
                getRecipientEmail() : string|null

Return values

string|null —

getRecipientId()

Gets recipient_id


    public
                getRecipientId() : string|null

Return values

string|null —

getRecipientName()

Gets recipient_name


    public
                getRecipientName() : string|null

Return values

string|null —

getRecipientRoleName()

Gets recipient_role_name


    public
                getRecipientRoleName() : string|null

Return values

string|null —

getRecipientTemplateRoleName()

Gets recipient_template_role_name


    public
                getRecipientTemplateRoleName() : string|null

Return values

string|null —

getRecipientTitle()

Gets recipient_title


    public
                getRecipientTitle() : string|null

Return values

string|null —

getRecipientType()

Gets recipient_type


    public
                getRecipientType() : string|null

Return values

string|null —

getRecipientUserId()

Gets recipient_user_id


    public
                getRecipientUserId() : string|null

Return values

string|null —

getRemainingSignatures()

Gets remaining_signatures


    public
                getRemainingSignatures() : string|null

Return values

string|null —

getRoutingOrder()

Gets routing_order


    public
                getRoutingOrder() : string|null

Return values

string|null —

getSenderAccountId()

Gets sender_account_id


    public
                getSenderAccountId() : string|null

Return values

string|null —

getSenderCompanyName()

Gets sender_company_name


    public
                getSenderCompanyName() : string|null

Return values

string|null —

getSenderCountry()

Gets sender_country


    public
                getSenderCountry() : string|null

Return values

string|null —

getSenderEmail()

Gets sender_email


    public
                getSenderEmail() : string|null

Return values

string|null —

getSenderIpAddress()

Gets sender_ip_address


    public
                getSenderIpAddress() : string|null

Return values

string|null —

getSenderJobTitle()

Gets sender_job_title


    public
                getSenderJobTitle() : string|null

Return values

string|null —

getSenderName()

Gets sender_name


    public
                getSenderName() : string|null

Return values

string|null —

getSenderUserId()

Gets sender_user_id


    public
                getSenderUserId() : string|null

Return values

string|null —

getSignatureType()

Gets signature_type


    public
                getSignatureType() : string|null

Return values

string|null —

getSignatureTypeValue()

Gets signature_type_value


    public
                getSignatureTypeValue() : string|null

Return values

string|null —

getSignDate()

Gets sign_date


    public
                getSignDate() : string|null

Return values

string|null —

getSigned()

Gets signed


    public
                getSigned() : string|null

Return values

string|null —

getSignedDate()

Gets signed_date


    public
                getSignedDate() : string|null

Return values

string|null —

getSignedOnMobile()

Gets signed_on_mobile


    public
                getSignedOnMobile() : string|null

Return values

string|null —

getSignedOnPaper()

Gets signed_on_paper


    public
                getSignedOnPaper() : string|null

Return values

string|null —

getSignerList()

Gets signer_list


    public
                getSignerList() : string|null

Return values

string|null —

getStatus()

Gets status


    public
                getStatus() : string|null

Return values

string|null —

getStatusChangedDate()

Gets status_changed_date


    public
                getStatusChangedDate() : string|null

Return values

string|null —

getStatusChangedTs()

Gets status_changed_ts


    public
                getStatusChangedTs() : string|null

Return values

string|null —

getStatusComment()

Gets status_comment


    public
                getStatusComment() : string|null

Return values

string|null —

getSubject()

Gets subject


    public
                getSubject() : string|null

Return values

string|null —

getSuccesses()

Gets successes


    public
                getSuccesses() : string|null

Return values

string|null —

getTemplateId()

Gets template_id


    public
                getTemplateId() : string|null

Return values

string|null —

getTemplateName()

Gets template_name


    public
                getTemplateName() : string|null

Return values

string|null —

getTemplatesCreated()

Gets templates_created


    public
                getTemplatesCreated() : string|null

Return values

string|null —

getTemplatesCreatedCount()

Gets templates_created_count


    public
                getTemplatesCreatedCount() : string|null

Return values

string|null —

getTerminalStatusDate()

Gets terminal_status_date


    public
                getTerminalStatusDate() : string|null

Return values

string|null —

getters()

Array of attributes to getter functions (for serialization of requests)


    public
            static    getters() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getTimeToCompleteSeconds()

Gets time_to_complete_seconds


    public
                getTimeToCompleteSeconds() : string|null

Return values

string|null —

getTimeToDeliver()

Gets time_to_deliver


    public
                getTimeToDeliver() : string|null

Return values

string|null —

getTotalDocuments()

Gets total_documents


    public
                getTotalDocuments() : string|null

Return values

string|null —

getTotalEnvelopes()

Gets total_envelopes


    public
                getTotalEnvelopes() : string|null

Return values

string|null —

getTotalPages()

Gets total_pages


    public
                getTotalPages() : string|null

Return values

string|null —

getTotalRecipients()

Gets total_recipients


    public
                getTotalRecipients() : string|null

Return values

string|null —

getTotalSigners()

Gets total_signers


    public
                getTotalSigners() : string|null

Return values

string|null —

getUniqueSenders()

Gets unique_senders


    public
                getUniqueSenders() : string|null

Return values

string|null —

getUserAccountEmail()

Gets user_account_email


    public
                getUserAccountEmail() : string|null

Return values

string|null —

getUserAccountName()

Gets user_account_name


    public
                getUserAccountName() : string|null

Return values

string|null —

getUserAccountStatus()

Gets user_account_status


    public
                getUserAccountStatus() : string|null

Return values

string|null —

getUserCount()

Gets user_count


    public
                getUserCount() : string|null

Return values

string|null —

getUserId()

Gets user_id


    public
                getUserId() : string|null

Return values

string|null —

getVerificationStatus()

Gets verification_status


    public
                getVerificationStatus() : string|null

Return values

string|null —

getVerificationType()

Gets verification_type


    public
                getVerificationType() : string|null

Return values

string|null —

getViewDate()

Gets view_date


    public
                getViewDate() : string|null

Return values

string|null —

getVoidedTs()

Gets voided_ts


    public
                getVoidedTs() : string|null

Return values

string|null —

listInvalidProperties()

Show all the invalid properties with reasons.


    public
                listInvalidProperties() : array<string|int, mixed>

Return values

array<string|int, mixed> —

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.


    public
                offsetExists(int $offset) : bool

Parameters

$offset : int: Offset

Return values

bool —

offsetGet()

Gets offset.


    public
                offsetGet(int $offset) : mixed

Parameters

$offset : int: Offset

Return values

mixed —

offsetSet()

Sets value based on offset.


    public
                offsetSet(int $offset, mixed $value) : void

Parameters

$offset : int: Offset
$value : mixed: Value to be set

Return values

void —

offsetUnset()

Unsets offset.


    public
                offsetUnset(int $offset) : void

Parameters

$offset : int: Offset

Return values

void —

setAccessCodeRequired()

Sets access_code_required


    public
                setAccessCodeRequired(string|null $access_code_required) : $this

Parameters

$access_code_required : string|null

Return values

$this —

setAccessCodesAttempted()

Sets access_codes_attempted


    public
                setAccessCodesAttempted(string|null $access_codes_attempted) : $this

Parameters

$access_codes_attempted : string|null

Return values

$this —

setAccessCodesFailed()

Sets access_codes_failed


    public
                setAccessCodesFailed(string|null $access_codes_failed) : $this

Parameters

$access_codes_failed : string|null

Return values

$this —

setAccountId()

Sets account_id


    public
                setAccountId(string|null $account_id) : $this

Parameters

$account_id : string|null: The account ID associated with the envelope.

Return values

$this —

setAuthenticationCategory()

Sets authentication_category


    public
                setAuthenticationCategory(string|null $authentication_category) : $this

Parameters

$authentication_category : string|null

Return values

$this —

setAuthenticationSuccess()

Sets authentication_success


    public
                setAuthenticationSuccess(string|null $authentication_success) : $this

Parameters

$authentication_success : string|null

Return values

$this —

setAuthenticationType()

Sets authentication_type


    public
                setAuthenticationType(string|null $authentication_type) : $this

Parameters

$authentication_type : string|null

Return values

$this —

setAverageTimeToCompleteSeconds()

Sets average_time_to_complete_seconds


    public
                setAverageTimeToCompleteSeconds(string|null $average_time_to_complete_seconds) : $this

Parameters

$average_time_to_complete_seconds : string|null

Return values

$this —

setAvgCompleteSeconds()

Sets avg_complete_seconds


    public
                setAvgCompleteSeconds(string|null $avg_complete_seconds) : $this

Parameters

$avg_complete_seconds : string|null

Return values

$this —

setCaptureMethod()

Sets capture_method


    public
                setCaptureMethod(string|null $capture_method) : $this

Parameters

$capture_method : string|null

Return values

$this —

setCompleted()

Sets completed


    public
                setCompleted(string|null $completed) : $this

Parameters

$completed : string|null

Return values

$this —

setCompletedTs()

Sets completed_ts


    public
                setCompletedTs(string|null $completed_ts) : $this

Parameters

$completed_ts : string|null

Return values

$this —

setCreatedDate()

Sets created_date


    public
                setCreatedDate(string|null $created_date) : $this

Parameters

$created_date : string|null

Return values

$this —

setCreatedOn()

Sets created_on


    public
                setCreatedOn(string|null $created_on) : $this

Parameters

$created_on : string|null

Return values

$this —

setCreator()

Sets creator


    public
                setCreator(string|null $creator) : $this

Parameters

$creator : string|null

Return values

$this —

setCustomField()

Sets custom_field


    public
                setCustomField(string|null $custom_field) : $this

Parameters

$custom_field : string|null

Return values

$this —

setDeclinedDate()

Sets declined_date


    public
                setDeclinedDate(string|null $declined_date) : $this

Parameters

$declined_date : string|null

Return values

$this —

setDeclinedReason()

Sets declined_reason


    public
                setDeclinedReason(string|null $declined_reason) : $this

Parameters

$declined_reason : string|null: The reason the recipient declined the document.

Return values

$this —

setDeliveredDate()

Sets delivered_date


    public
                setDeliveredDate(string|null $delivered_date) : $this

Parameters

$delivered_date : string|null

Return values

$this —

setEnvelopeCount()

Sets envelope_count


    public
                setEnvelopeCount(string|null $envelope_count) : $this

Parameters

$envelope_count : string|null

Return values

$this —

setEnvelopeCreator()

Sets envelope_creator


    public
                setEnvelopeCreator(string|null $envelope_creator) : $this

Parameters

$envelope_creator : string|null

Return values

$this —

setEnvelopeId()

Sets envelope_id


    public
                setEnvelopeId(string|null $envelope_id) : $this

Parameters

$envelope_id : string|null: The envelope ID of the envelope status that failed to post.

Return values

$this —

setEnvelopeInitialSendTs()

Sets envelope_initial_send_ts


    public
                setEnvelopeInitialSendTs(string|null $envelope_initial_send_ts) : $this

Parameters

$envelope_initial_send_ts : string|null

Return values

$this —

setEnvelopesBilled()

Sets envelopes_billed


    public
                setEnvelopesBilled(string|null $envelopes_billed) : $this

Parameters

$envelopes_billed : string|null

Return values

$this —

setEnvelopesCompleted()

Sets envelopes_completed


    public
                setEnvelopesCompleted(string|null $envelopes_completed) : $this

Parameters

$envelopes_completed : string|null

Return values

$this —

setEnvelopesCompletedCount()

Sets envelopes_completed_count


    public
                setEnvelopesCompletedCount(string|null $envelopes_completed_count) : $this

Parameters

$envelopes_completed_count : string|null

Return values

$this —

setEnvelopesDeclined()

Sets envelopes_declined


    public
                setEnvelopesDeclined(string|null $envelopes_declined) : $this

Parameters

$envelopes_declined : string|null

Return values

$this —

setEnvelopesSent()

Sets envelopes_sent


    public
                setEnvelopesSent(string|null $envelopes_sent) : $this

Parameters

$envelopes_sent : string|null

Return values

$this —

setEnvelopesSentCount()

Sets envelopes_sent_count


    public
                setEnvelopesSentCount(string|null $envelopes_sent_count) : $this

Parameters

$envelopes_sent_count : string|null

Return values

$this —

setEnvelopesVoided()

Sets envelopes_voided


    public
                setEnvelopesVoided(string|null $envelopes_voided) : $this

Parameters

$envelopes_voided : string|null

Return values

$this —

setEnvelopeVoidedReason()

Sets envelope_voided_reason


    public
                setEnvelopeVoidedReason(string|null $envelope_voided_reason) : $this

Parameters

$envelope_voided_reason : string|null

Return values

$this —

setEodDocumentDescription()

Sets eod_document_description


    public
                setEodDocumentDescription(string|null $eod_document_description) : $this

Parameters

$eod_document_description : string|null

Return values

$this —

setEodDocumentName()

Sets eod_document_name


    public
                setEodDocumentName(string|null $eod_document_name) : $this

Parameters

$eod_document_name : string|null

Return values

$this —

setEodDocumentProfileId()

Sets eod_document_profile_id


    public
                setEodDocumentProfileId(string|null $eod_document_profile_id) : $this

Parameters

$eod_document_profile_id : string|null

Return values

$this —

setEodTransactionId()

Sets eod_transaction_id


    public
                setEodTransactionId(string|null $eod_transaction_id) : $this

Parameters

$eod_transaction_id : string|null

Return values

$this —

setEodTransactionName()

Sets eod_transaction_name


    public
                setEodTransactionName(string|null $eod_transaction_name) : $this

Parameters

$eod_transaction_name : string|null

Return values

$this —

setEventDate()

Sets event_date


    public
                setEventDate(string|null $event_date) : $this

Parameters

$event_date : string|null

Return values

$this —

setExpirationDate()

Sets expiration_date


    public
                setExpirationDate(string|null $expiration_date) : $this

Parameters

$expiration_date : string|null

Return values

$this —

setExpiredTs()

Sets expired_ts


    public
                setExpiredTs(string|null $expired_ts) : $this

Parameters

$expired_ts : string|null

Return values

$this —

setFailureReason()

Sets failure_reason


    public
                setFailureReason(string|null $failure_reason) : $this

Parameters

$failure_reason : string|null

Return values

$this —

setFailures()

Sets failures


    public
                setFailures(string|null $failures) : $this

Parameters

$failures : string|null

Return values

$this —

setFailureVendorCode()

Sets failure_vendor_code


    public
                setFailureVendorCode(string|null $failure_vendor_code) : $this

Parameters

$failure_vendor_code : string|null

Return values

$this —

setFailureVendorReason()

Sets failure_vendor_reason


    public
                setFailureVendorReason(string|null $failure_vendor_reason) : $this

Parameters

$failure_vendor_reason : string|null

Return values

$this —

setFirstSendTs()

Sets first_send_ts


    public
                setFirstSendTs(string|null $first_send_ts) : $this

Parameters

$first_send_ts : string|null

Return values

$this —

setGroupId()

Sets group_id


    public
                setGroupId(string|null $group_id) : $this

Parameters

$group_id : string|null

Return values

$this —

setGroupName()

Sets group_name


    public
                setGroupName(string|null $group_name) : $this

Parameters

$group_name : string|null: The name of the group.

Return values

$this —

setHoursToCompleteEnd()

Sets hours_to_complete_end


    public
                setHoursToCompleteEnd(string|null $hours_to_complete_end) : $this

Parameters

$hours_to_complete_end : string|null

Return values

$this —

setHoursToCompleteStart()

Sets hours_to_complete_start


    public
                setHoursToCompleteStart(string|null $hours_to_complete_start) : $this

Parameters

$hours_to_complete_start : string|null

Return values

$this —

setIdChecksAttempted()

Sets id_checks_attempted


    public
                setIdChecksAttempted(string|null $id_checks_attempted) : $this

Parameters

$id_checks_attempted : string|null

Return values

$this —

setIdChecksFailed()

Sets id_checks_failed


    public
                setIdChecksFailed(string|null $id_checks_failed) : $this

Parameters

$id_checks_failed : string|null

Return values

$this —

setIdCountry()

Sets id_country


    public
                setIdCountry(string|null $id_country) : $this

Parameters

$id_country : string|null

Return values

$this —

setIdMethod()

Sets id_method


    public
                setIdMethod(string|null $id_method) : $this

Parameters

$id_method : string|null

Return values

$this —

setInitialSendTs()

Sets initial_send_ts


    public
                setInitialSendTs(string|null $initial_send_ts) : $this

Parameters

$initial_send_ts : string|null

Return values

$this —

setIpAddress()

Sets ip_address


    public
                setIpAddress(string|null $ip_address) : $this

Parameters

$ip_address : string|null

Return values

$this —

setLastActivity()

Sets last_activity


    public
                setLastActivity(string|null $last_activity) : $this

Parameters

$last_activity : string|null

Return values

$this —

setLastActivityDate()

Sets last_activity_date


    public
                setLastActivityDate(string|null $last_activity_date) : $this

Parameters

$last_activity_date : string|null

Return values

$this —

setLastModified()

Sets last_modified


    public
                setLastModified(string|null $last_modified) : $this

Parameters

$last_modified : string|null

Return values

$this —

setLastSentDate()

Sets last_sent_date


    public
                setLastSentDate(string|null $last_sent_date) : $this

Parameters

$last_sent_date : string|null

Return values

$this —

setLastUsed()

Sets last_used


    public
                setLastUsed(string|null $last_used) : $this

Parameters

$last_used : string|null

Return values

$this —

setMetadataRemoved()

Sets metadata_removed


    public
                setMetadataRemoved(string|null $metadata_removed) : $this

Parameters

$metadata_removed : string|null

Return values

$this —

setNotSigned()

Sets not_signed


    public
                setNotSigned(string|null $not_signed) : $this

Parameters

$not_signed : string|null

Return values

$this —

setNumberOfAuthenticatedRecipients()

Sets number_of_authenticated_recipients


    public
                setNumberOfAuthenticatedRecipients(string|null $number_of_authenticated_recipients) : $this

Parameters

$number_of_authenticated_recipients : string|null

Return values

$this —

setNumberOfCompletedSignatures()

Sets number_of_completed_signatures


    public
                setNumberOfCompletedSignatures(string|null $number_of_completed_signatures) : $this

Parameters

$number_of_completed_signatures : string|null

Return values

$this —

setNumberOfDocuments()

Sets number_of_documents


    public
                setNumberOfDocuments(string|null $number_of_documents) : $this

Parameters

$number_of_documents : string|null

Return values

$this —

setNumberOfPages()

Sets number_of_pages


    public
                setNumberOfPages(string|null $number_of_pages) : $this

Parameters

$number_of_pages : string|null

Return values

$this —

setNumberOfRecipients()

Sets number_of_recipients


    public
                setNumberOfRecipients(string|null $number_of_recipients) : $this

Parameters

$number_of_recipients : string|null

Return values

$this —

setNumberOfSends()

Sets number_of_sends


    public
                setNumberOfSends(string|null $number_of_sends) : $this

Parameters

$number_of_sends : string|null

Return values

$this —

setNumberOfSigners()

Sets number_of_signers


    public
                setNumberOfSigners(string|null $number_of_signers) : $this

Parameters

$number_of_signers : string|null

Return values

$this —

setNumberOfTotalDocuments()

Sets number_of_total_documents


    public
                setNumberOfTotalDocuments(string|null $number_of_total_documents) : $this

Parameters

$number_of_total_documents : string|null

Return values

$this —

setNumberOfTotalPages()

Sets number_of_total_pages


    public
                setNumberOfTotalPages(string|null $number_of_total_pages) : $this

Parameters

$number_of_total_pages : string|null

Return values

$this —

setNumberOfTotalSigners()

Sets number_of_total_signers


    public
                setNumberOfTotalSigners(string|null $number_of_total_signers) : $this

Parameters

$number_of_total_signers : string|null

Return values

$this —

setNumberOfUniqueSenders()

Sets number_of_unique_senders


    public
                setNumberOfUniqueSenders(string|null $number_of_unique_senders) : $this

Parameters

$number_of_unique_senders : string|null

Return values

$this —

setNumberTotalRecipients()

Sets number_total_recipients


    public
                setNumberTotalRecipients(string|null $number_total_recipients) : $this

Parameters

$number_total_recipients : string|null

Return values

$this —

setOtherRecipientsList()

Sets other_recipients_list


    public
                setOtherRecipientsList(string|null $other_recipients_list) : $this

Parameters

$other_recipients_list : string|null

Return values

$this —

setOwner()

Sets owner


    public
                setOwner(string|null $owner) : $this

Parameters

$owner : string|null

Return values

$this —

setOwnerMail()

Sets owner_mail


    public
                setOwnerMail(string|null $owner_mail) : $this

Parameters

$owner_mail : string|null

Return values

$this —

setPeriodEnd()

Sets period_end


    public
                setPeriodEnd(string|null $period_end) : $this

Parameters

$period_end : string|null

Return values

$this —

setPeriodStart()

Sets period_start


    public
                setPeriodStart(string|null $period_start) : $this

Parameters

$period_start : string|null

Return values

$this —

setPhoneCallsAttempted()

Sets phone_calls_attempted


    public
                setPhoneCallsAttempted(string|null $phone_calls_attempted) : $this

Parameters

$phone_calls_attempted : string|null

Return values

$this —

setPhoneCallsFailed()

Sets phone_calls_failed


    public
                setPhoneCallsFailed(string|null $phone_calls_failed) : $this

Parameters

$phone_calls_failed : string|null

Return values

$this —

setPiiRedacted()

Sets pii_redacted


    public
                setPiiRedacted(string|null $pii_redacted) : $this

Parameters

$pii_redacted : string|null

Return values

$this —

setPurgeDate()

Sets purge_date


    public
                setPurgeDate(string|null $purge_date) : $this

Parameters

$purge_date : string|null

Return values

$this —

setReasonForDeclining()

Sets reason_for_declining


    public
                setReasonForDeclining(string|null $reason_for_declining) : $this

Parameters

$reason_for_declining : string|null

Return values

$this —

setReasonForVoiding()

Sets reason_for_voiding


    public
                setReasonForVoiding(string|null $reason_for_voiding) : $this

Parameters

$reason_for_voiding : string|null

Return values

$this —

setReassignReason()

Sets reassign_reason


    public
                setReassignReason(string|null $reassign_reason) : $this

Parameters

$reassign_reason : string|null

Return values

$this —

setReceived()

Sets received


    public
                setReceived(string|null $received) : $this

Parameters

$received : string|null

Return values

$this —

setRecipient()

Sets recipient


    public
                setRecipient(string|null $recipient) : $this

Parameters

$recipient : string|null

Return values

$this —

setRecipientAction()

Sets recipient_action


    public
                setRecipientAction(string|null $recipient_action) : $this

Parameters

$recipient_action : string|null

Return values

$this —

setRecipientCompanyName()

Sets recipient_company_name


    public
                setRecipientCompanyName(string|null $recipient_company_name) : $this

Parameters

$recipient_company_name : string|null

Return values

$this —

setRecipientCountry()

Sets recipient_country


    public
                setRecipientCountry(string|null $recipient_country) : $this

Parameters

$recipient_country : string|null

Return values

$this —

setRecipientEmail()

Sets recipient_email


    public
                setRecipientEmail(string|null $recipient_email) : $this

Parameters

$recipient_email : string|null

Return values

$this —

setRecipientId()

Sets recipient_id


    public
                setRecipientId(string|null $recipient_id) : $this

Parameters

$recipient_id : string|null: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

Return values

$this —

setRecipientName()

Sets recipient_name


    public
                setRecipientName(string|null $recipient_name) : $this

Parameters

$recipient_name : string|null

Return values

$this —

setRecipientRoleName()

Sets recipient_role_name


    public
                setRecipientRoleName(string|null $recipient_role_name) : $this

Parameters

$recipient_role_name : string|null

Return values

$this —

setRecipientTemplateRoleName()

Sets recipient_template_role_name


    public
                setRecipientTemplateRoleName(string|null $recipient_template_role_name) : $this

Parameters

$recipient_template_role_name : string|null

Return values

$this —

setRecipientTitle()

Sets recipient_title


    public
                setRecipientTitle(string|null $recipient_title) : $this

Parameters

$recipient_title : string|null

Return values

$this —

setRecipientType()

Sets recipient_type


    public
                setRecipientType(string|null $recipient_type) : $this

Parameters

$recipient_type : string|null

Return values

$this —

setRecipientUserId()

Sets recipient_user_id


    public
                setRecipientUserId(string|null $recipient_user_id) : $this

Parameters

$recipient_user_id : string|null

Return values

$this —

setRemainingSignatures()

Sets remaining_signatures


    public
                setRemainingSignatures(string|null $remaining_signatures) : $this

Parameters

$remaining_signatures : string|null

Return values

$this —

setRoutingOrder()

Sets routing_order


    public
                setRoutingOrder(string|null $routing_order) : $this

Parameters

$routing_order : string|null: Specifies the routing order of the recipient in the envelope.

Return values

$this —

setSenderAccountId()

Sets sender_account_id


    public
                setSenderAccountId(string|null $sender_account_id) : $this

Parameters

$sender_account_id : string|null

Return values

$this —

setSenderCompanyName()

Sets sender_company_name


    public
                setSenderCompanyName(string|null $sender_company_name) : $this

Parameters

$sender_company_name : string|null

Return values

$this —

setSenderCountry()

Sets sender_country


    public
                setSenderCountry(string|null $sender_country) : $this

Parameters

$sender_country : string|null

Return values

$this —

setSenderEmail()

Sets sender_email


    public
                setSenderEmail(string|null $sender_email) : $this

Parameters

$sender_email : string|null

Return values

$this —

setSenderIpAddress()

Sets sender_ip_address


    public
                setSenderIpAddress(string|null $sender_ip_address) : $this

Parameters

$sender_ip_address : string|null

Return values

$this —

setSenderJobTitle()

Sets sender_job_title


    public
                setSenderJobTitle(string|null $sender_job_title) : $this

Parameters

$sender_job_title : string|null

Return values

$this —

setSenderName()

Sets sender_name


    public
                setSenderName(string|null $sender_name) : $this

Parameters

$sender_name : string|null

Return values

$this —

setSenderUserId()

Sets sender_user_id


    public
                setSenderUserId(string|null $sender_user_id) : $this

Parameters

$sender_user_id : string|null

Return values

$this —

setSignatureType()

Sets signature_type


    public
                setSignatureType(string|null $signature_type) : $this

Parameters

$signature_type : string|null

Return values

$this —

setSignatureTypeValue()

Sets signature_type_value


    public
                setSignatureTypeValue(string|null $signature_type_value) : $this

Parameters

$signature_type_value : string|null

Return values

$this —

setSignDate()

Sets sign_date


    public
                setSignDate(string|null $sign_date) : $this

Parameters

$sign_date : string|null

Return values

$this —

setSigned()

Sets signed


    public
                setSigned(string|null $signed) : $this

Parameters

$signed : string|null

Return values

$this —

setSignedDate()

Sets signed_date


    public
                setSignedDate(string|null $signed_date) : $this

Parameters

$signed_date : string|null

Return values

$this —

setSignedOnMobile()

Sets signed_on_mobile


    public
                setSignedOnMobile(string|null $signed_on_mobile) : $this

Parameters

$signed_on_mobile : string|null

Return values

$this —

setSignedOnPaper()

Sets signed_on_paper


    public
                setSignedOnPaper(string|null $signed_on_paper) : $this

Parameters

$signed_on_paper : string|null

Return values

$this —

setSignerList()

Sets signer_list


    public
                setSignerList(string|null $signer_list) : $this

Parameters

$signer_list : string|null

Return values

$this —

setStatus()

Sets status


    public
                setStatus(string|null $status) : $this

Parameters

$status : string|null: Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.

Return values

$this —

setStatusChangedDate()

Sets status_changed_date


    public
                setStatusChangedDate(string|null $status_changed_date) : $this

Parameters

$status_changed_date : string|null

Return values

$this —

setStatusChangedTs()

Sets status_changed_ts


    public
                setStatusChangedTs(string|null $status_changed_ts) : $this

Parameters

$status_changed_ts : string|null

Return values

$this —

setStatusComment()

Sets status_comment


    public
                setStatusComment(string|null $status_comment) : $this

Parameters

$status_comment : string|null

Return values

$this —

setSubject()

Sets subject


    public
                setSubject(string|null $subject) : $this

Parameters

$subject : string|null

Return values

$this —

setSuccesses()

Sets successes


    public
                setSuccesses(string|null $successes) : $this

Parameters

$successes : string|null

Return values

$this —

setTemplateId()

Sets template_id


    public
                setTemplateId(string|null $template_id) : $this

Parameters

$template_id : string|null: The unique identifier of the template. If this is not provided, DocuSign will generate a value.

Return values

$this —

setTemplateName()

Sets template_name


    public
                setTemplateName(string|null $template_name) : $this

Parameters

$template_name : string|null

Return values

$this —

setTemplatesCreated()

Sets templates_created


    public
                setTemplatesCreated(string|null $templates_created) : $this

Parameters

$templates_created : string|null

Return values

$this —

setTemplatesCreatedCount()

Sets templates_created_count


    public
                setTemplatesCreatedCount(string|null $templates_created_count) : $this

Parameters

$templates_created_count : string|null

Return values

$this —

setTerminalStatusDate()

Sets terminal_status_date


    public
                setTerminalStatusDate(string|null $terminal_status_date) : $this

Parameters

$terminal_status_date : string|null

Return values

$this —

setters()

Array of attributes to setter functions (for deserialization of responses)


    public
            static    setters() : array<string|int, mixed>

Return values

array<string|int, mixed> —

setTimeToCompleteSeconds()

Sets time_to_complete_seconds


    public
                setTimeToCompleteSeconds(string|null $time_to_complete_seconds) : $this

Parameters

$time_to_complete_seconds : string|null

Return values

$this —

setTimeToDeliver()

Sets time_to_deliver


    public
                setTimeToDeliver(string|null $time_to_deliver) : $this

Parameters

$time_to_deliver : string|null

Return values

$this —

setTotalDocuments()

Sets total_documents


    public
                setTotalDocuments(string|null $total_documents) : $this

Parameters

$total_documents : string|null

Return values

$this —

setTotalEnvelopes()

Sets total_envelopes


    public
                setTotalEnvelopes(string|null $total_envelopes) : $this

Parameters

$total_envelopes : string|null

Return values

$this —

setTotalPages()

Sets total_pages


    public
                setTotalPages(string|null $total_pages) : $this

Parameters

$total_pages : string|null

Return values

$this —

setTotalRecipients()

Sets total_recipients


    public
                setTotalRecipients(string|null $total_recipients) : $this

Parameters

$total_recipients : string|null

Return values

$this —

setTotalSigners()

Sets total_signers


    public
                setTotalSigners(string|null $total_signers) : $this

Parameters

$total_signers : string|null

Return values

$this —

setUniqueSenders()

Sets unique_senders


    public
                setUniqueSenders(string|null $unique_senders) : $this

Parameters

$unique_senders : string|null

Return values

$this —

setUserAccountEmail()

Sets user_account_email


    public
                setUserAccountEmail(string|null $user_account_email) : $this

Parameters

$user_account_email : string|null

Return values

$this —

setUserAccountName()

Sets user_account_name


    public
                setUserAccountName(string|null $user_account_name) : $this

Parameters

$user_account_name : string|null

Return values

$this —

setUserAccountStatus()

Sets user_account_status


    public
                setUserAccountStatus(string|null $user_account_status) : $this

Parameters

$user_account_status : string|null

Return values

$this —

setUserCount()

Sets user_count


    public
                setUserCount(string|null $user_count) : $this

Parameters

$user_count : string|null

Return values

$this —

setUserId()

Sets user_id


    public
                setUserId(string|null $user_id) : $this

Parameters

$user_id : string|null

Return values

$this —

setVerificationStatus()

Sets verification_status


    public
                setVerificationStatus(string|null $verification_status) : $this

Parameters

$verification_status : string|null

Return values

$this —

setVerificationType()

Sets verification_type


    public
                setVerificationType(string|null $verification_type) : $this

Parameters

$verification_type : string|null

Return values

$this —

setViewDate()

Sets view_date


    public
                setViewDate(string|null $view_date) : $this

Parameters

$view_date : string|null

Return values

$this —

setVoidedTs()

Sets voided_ts


    public
                setVoidedTs(string|null $voided_ts) : $this

Parameters

$voided_ts : string|null

Return values

$this —

swaggerFormats()

Array of property to format mappings. Used for (de)serialization


    public
            static    swaggerFormats() : array<string|int, mixed>

Return values

array<string|int, mixed> —

swaggerTypes()

Array of property to type mappings. Used for (de)serialization


    public
            static    swaggerTypes() : array<string|int, mixed>

Return values

array<string|int, mixed> —

valid()

Validate all the properties in the model return true if all passed


    public
                valid() : bool

Return values

bool —

True if all properties are valid

ReportInProductRunResponseRowFields in package DocuSign eSign implements ModelInterface, ArrayAccess

Tags

Interfaces, Classes, Traits and Enums

Table of Contents

Constants

DISCRIMINATOR

Properties

$attributeMap

$container

$getters

$setters

$swaggerFormats

$swaggerModelName

$swaggerTypes

Methods

__construct()

Parameters

Return values

__toString()

Return values

attributeMap()

Return values

getAccessCodeRequired()

Return values

getAccessCodesAttempted()

Return values

getAccessCodesFailed()

Return values

getAccountId()

Return values

getAuthenticationCategory()

Return values

getAuthenticationSuccess()

Return values

getAuthenticationType()

Return values

getAverageTimeToCompleteSeconds()

Return values

getAvgCompleteSeconds()

Return values

getCaptureMethod()

Return values

getCompleted()

Return values

getCompletedTs()

Return values

getCreatedDate()

Return values

getCreatedOn()

Return values

getCreator()

Return values

getCustomField()

Return values

getDeclinedDate()

Return values

getDeclinedReason()

Return values

getDeliveredDate()

Return values

getEnvelopeCount()

Return values

getEnvelopeCreator()

Return values

getEnvelopeId()

Return values

getEnvelopeInitialSendTs()

Return values

getEnvelopesBilled()

Return values

getEnvelopesCompleted()

Return values

getEnvelopesCompletedCount()

Return values

getEnvelopesDeclined()

Return values

getEnvelopesSent()

Return values

getEnvelopesSentCount()

Return values

ReportInProductRunResponseRowFields
in package

DocuSign

eSign

implements ModelInterface, ArrayAccess