Interfolio API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class representing packet evaluator section api calls

Hierarchy

  • PacketAttachmentApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

apiRequest

apiRequest: ApiRequest

API request object for making the actual http requests

Methods

addDocument

  • addDocument(__namedParameters: { displayName: string; file: string | Readable | Buffer; fileName: string; packetId: number; sectionId: number }): Promise<PacketDocument>

  • Add a document to a packet

    Parameters

    • __namedParameters: { displayName: string; file: string | Readable | Buffer; fileName: string; packetId: number; sectionId: number }
      • displayName: string

        Name of the document to be displayed in the reader

      • file: string | Readable | Buffer

        The file contents

      • fileName: string

        The file name for the file

      • packetId: number

        ID of the packet/case

      • sectionId: number

        Section ID in which to place the document

    Returns Promise<PacketDocument>

delete

  • delete(__namedParameters: { packetAttachmentId: number; packetId: number }): Promise<boolean>

  • delete a packet attachment (document uplaoded for the case)

    exmaple
    const deleted = await api.Tenure.PacketAttachments.delete({packetId: 9999, packetAttachmentId: 9999});

    Parameters

    • __namedParameters: { packetAttachmentId: number; packetId: number }
      • packetAttachmentId: number

        Packet attachment id

      • packetId: number

        Packet id

    Returns Promise<boolean>

Legend

  • Class
  • Constructor
  • Property
  • Method
  • Variable
  • Function
  • Type alias

Generated using TypeDoc