PDFGate's PHP SDK

PdfGateEnvelope
in package

Envelope DTO returned by the create envelope endpoint.

Table of Contents

Properties

$completedAt  : DateTimeImmutable|null
$createdAt  : DateTimeImmutable
$documents  : array<int, EnvelopeDocumentResponse>
$expiredAt  : DateTimeImmutable|null
$id  : string
$metadata  : array<string, mixed>|null
$status  : string

Methods

__construct()  : mixed
fromArray()  : self
getCompletedAt()  : DateTimeImmutable|null
getCreatedAt()  : DateTimeImmutable
getDocuments()  : array<int, EnvelopeDocumentResponse>
getExpiredAt()  : DateTimeImmutable|null
getId()  : string
getMetadata()  : array<string, mixed>|null
getStatus()  : string
Returns one of the EnvelopeStatus constants.
parseOptionalDate()  : DateTimeImmutable|null
parseRequiredDate()  : DateTimeImmutable

Properties

Methods

__construct()

public __construct(string $id, string $status, array<int, EnvelopeDocumentResponse> $documents, DateTimeImmutable $createdAt[, DateTimeImmutable|null $completedAt = null ][, DateTimeImmutable|null $expiredAt = null ][, array<string, mixed>|null $metadata = null ]) : mixed
Parameters
$id : string
$status : string

One of the EnvelopeStatus constants.

$documents : array<int, EnvelopeDocumentResponse>
$createdAt : DateTimeImmutable
$completedAt : DateTimeImmutable|null = null
$expiredAt : DateTimeImmutable|null = null
$metadata : array<string, mixed>|null = null

fromArray()

public static fromArray(array<string, mixed> $payload) : self
Parameters
$payload : array<string, mixed>
Return values
self

getCompletedAt()

public getCompletedAt() : DateTimeImmutable|null
Return values
DateTimeImmutable|null

getCreatedAt()

public getCreatedAt() : DateTimeImmutable
Return values
DateTimeImmutable

getExpiredAt()

public getExpiredAt() : DateTimeImmutable|null
Return values
DateTimeImmutable|null

getMetadata()

public getMetadata() : array<string, mixed>|null
Return values
array<string, mixed>|null

getStatus()

Returns one of the EnvelopeStatus constants.

public getStatus() : string
Return values
string

parseOptionalDate()

private static parseOptionalDate(array<string, mixed> $payload, string $field) : DateTimeImmutable|null
Parameters
$payload : array<string, mixed>
$field : string
Return values
DateTimeImmutable|null

parseRequiredDate()

private static parseRequiredDate(array<string, mixed> $payload, string $field) : DateTimeImmutable
Parameters
$payload : array<string, mixed>
$field : string
Return values
DateTimeImmutable 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results