EnvelopeRecipientResponse
in package
Recipient payload returned for an envelope document.
Table of Contents
Properties
- $email : string
- $fields : array<int, EnvelopeFieldResponse>
- $signedAt : DateTimeImmutable|null
- $status : string
- $viewedAt : DateTimeImmutable|null
Methods
- __construct() : mixed
- fromArray() : self
- getEmail() : string
- getFields() : array<int, EnvelopeFieldResponse>
- getSignedAt() : DateTimeImmutable|null
- getStatus() : string
- Returns one of the DocumentRecipientStatus constants.
- getViewedAt() : DateTimeImmutable|null
- parseOptionalDate() : DateTimeImmutable|null
Properties
private
string
$email
$fields
private
array<int, EnvelopeFieldResponse>
$fields
$signedAt
private
DateTimeImmutable|null
$signedAt
$status
private
string
$status
One of the DocumentRecipientStatus constants.
$viewedAt
private
DateTimeImmutable|null
$viewedAt
Methods
__construct()
public
__construct(string $email, string $status, DateTimeImmutable|null $signedAt, DateTimeImmutable|null $viewedAt, array<int, EnvelopeFieldResponse> $fields) : mixed
Parameters
- $email : string
- $status : string
-
One of the DocumentRecipientStatus constants.
- $signedAt : DateTimeImmutable|null
- $viewedAt : DateTimeImmutable|null
- $fields : array<int, EnvelopeFieldResponse>
fromArray()
public
static fromArray(array<string, mixed> $payload) : self
Parameters
- $payload : array<string, mixed>
Return values
selfgetEmail()
public
getEmail() : string
Return values
stringgetFields()
public
getFields() : array<int, EnvelopeFieldResponse>
Return values
array<int, EnvelopeFieldResponse>getSignedAt()
public
getSignedAt() : DateTimeImmutable|null
Return values
DateTimeImmutable|nullgetStatus()
Returns one of the DocumentRecipientStatus constants.
public
getStatus() : string
Return values
stringgetViewedAt()
public
getViewedAt() : DateTimeImmutable|null
Return values
DateTimeImmutable|nullparseOptionalDate()
private
static parseOptionalDate(array<string, mixed> $payload, string $field, string $context) : DateTimeImmutable|null
Parameters
- $payload : array<string, mixed>
- $field : string
- $context : string