Package com.pdfgate

Class PDFGateEnvelope

java.lang.Object
com.pdfgate.PDFGateEnvelope
public final class PDFGateEnvelope extends Object
Envelope metadata returned by JSON responses from the PDFGate API.

  • Constructor Details

    • PDFGateEnvelope

      public PDFGateEnvelope()
      Creates an empty envelope instance for JSON deserialization.

  • Method Details

    • getId

      public String getId()
      Returns the envelope identifier.
      Returns:
      the envelope identifier.

    • getStatus

      public EnvelopeStatus getStatus()
      Returns the envelope status.
      Returns:
      the envelope status.

    • getDocuments

      public List<EnvelopeDocumentResponse> getDocuments()
      Returns the document entries included in the envelope.
      Returns:
      the document entries included in the envelope.

    • getCreatedAt

      public Instant getCreatedAt()
      Returns when the envelope was created.
      Returns:
      when the envelope was created.

    • getCompletedAt

      public Optional<Instant> getCompletedAt()
      Returns when the envelope was completed, if present.
      Returns:
      when the envelope was completed, if present.

    • getExpiredAt

      public Optional<Instant> getExpiredAt()
      Returns when the envelope expired, if present.
      Returns:
      when the envelope expired, if present.

    • getMetadata

      public Optional<Map<String,Object>> getMetadata()
      Returns metadata attached to the envelope, if present.
      Returns:
      metadata attached to the envelope, if present.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object