PacketTypeApi | Interfolio API

Class representing Packet Type calls (e.g. Appointment/Reappointment)

Hierarchy

PacketTypeApi

Index

Constructors

constructor

Properties

apiRequest

Methods

getList

Constructors

constructor

new PacketTypeApi(config: ApiRequest | ApiConfig): PacketTypeApi

- Defined in tenure/packet-type-api.ts:20
Constructor for the object

Parameters
- config: ApiRequest | ApiConfig
  
  Configuration for API calls - of type either ApiConfig or ApiRequest
  
  note pass in ApiRequest to keep all errors in one object instance
Returns PacketTypeApi

Properties

Readonly apiRequest

apiRequest: ApiRequest

API request object for making the actual http requests

Methods

getList

getList(): Promise<PacketType[]>

- Defined in tenure/packet-type-api.ts:45
Get the list of packet types
example
```
let packetTypes = await api.Tenure.PacketTypes.getList();
```
Returns Promise<PacketType[]>

Generated using TypeDoc