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

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

Hierarchy

  • StatusApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • 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 StatusApi

Properties

Readonly apiRequest

apiRequest: ApiRequest

API request object for making the actual http requests

Methods

getList

  • getList(): Promise<Status[]>

  • Get the list of packet types

    example
    let statuses = await api.Tenure.Statuses.getList();

    Returns Promise<Status[]>

Legend

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

Generated using TypeDoc