EnvelopeDocumentResponse
in package
Document payload returned inside an envelope response.
Table of Contents
Properties
- $completedAt : DateTimeImmutable|null
- $recipients : array<int, EnvelopeRecipientResponse>
- $signedDocumentId : string|null
- $sourceDocumentId : string
- $status : string
Methods
- __construct() : mixed
- fromArray() : self
- getCompletedAt() : DateTimeImmutable|null
- getRecipients() : array<int, EnvelopeRecipientResponse>
- getSignedDocumentId() : string|null
- getSourceDocumentId() : string
- getStatus() : string
- Returns one of the EnvelopeDocumentStatus constants.
- parseOptionalDate() : DateTimeImmutable|null
Properties
$completedAt
private
DateTimeImmutable|null
$completedAt
$recipients
private
array<int, EnvelopeRecipientResponse>
$recipients
$signedDocumentId
private
string|null
$signedDocumentId
$sourceDocumentId
private
string
$sourceDocumentId
$status
private
string
$status
One of the EnvelopeDocumentStatus constants.
Methods
__construct()
public
__construct(string $sourceDocumentId, string|null $signedDocumentId, array<int, EnvelopeRecipientResponse> $recipients, string $status, DateTimeImmutable|null $completedAt) : mixed
Parameters
- $sourceDocumentId : string
- $signedDocumentId : string|null
- $recipients : array<int, EnvelopeRecipientResponse>
- $status : string
-
One of the EnvelopeDocumentStatus constants.
- $completedAt : DateTimeImmutable|null
fromArray()
public
static fromArray(array<string, mixed> $payload) : self
Parameters
- $payload : array<string, mixed>
Return values
selfgetCompletedAt()
public
getCompletedAt() : DateTimeImmutable|null
Return values
DateTimeImmutable|nullgetRecipients()
public
getRecipients() : array<int, EnvelopeRecipientResponse>
Return values
array<int, EnvelopeRecipientResponse>getSignedDocumentId()
public
getSignedDocumentId() : string|null
Return values
string|nullgetSourceDocumentId()
public
getSourceDocumentId() : string
Return values
stringgetStatus()
Returns one of the EnvelopeDocumentStatus constants.
public
getStatus() : string
Return values
stringparseOptionalDate()
private
static parseOptionalDate(array<string, mixed> $payload, string $field) : DateTimeImmutable|null
Parameters
- $payload : array<string, mixed>
- $field : string