PacketApi | Interfolio API

Class representing Packet calls

Hierarchy

PacketApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PacketApi(config: ApiRequest | ApiConfig): PacketApi

- Defined in tenure/packet-api.ts:303
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 PacketApi

Properties

EvaluatorSections

EvaluatorSections: EvaluatorSectionApi

PlatformForms

PlatformForms: PlatformFormApi

handle to PlatformFormApi

WorkflowSteps

WorkflowSteps: WorkflowStepApi

handle to WorkflowStepApi

Readonly apiRequest

apiRequest: ApiRequest

API request object for making the actual http requests

Methods

create

create(__namedParameters: { candidateEmail: string; candidateFirstName: string; candidateInvolvement: boolean; candidateLastName: string; candidatePID?: number; packetTypeId: number; unitId: number }): Promise<Packet>

- Defined in tenure/packet-api.ts:362
Create a new packet (case)
example
```
let case = await api.Tenure.Packets.create({unitId: 9999, candidateFirstName: "First",
    candidateLastName: "Last", candidateEmail:"firslast@email.com", candidateInvolvement: false, packetTypeId: 9999}):
```
Parameters
- __namedParameters: { candidateEmail: string; candidateFirstName: string; candidateInvolvement: boolean; candidateLastName: string; candidatePID?: number; packetTypeId: number; unitId: number }
  - candidateEmail: string
    
    Candidate's email address
  - candidateFirstName: string
    
    Candidate's first (given) name
  - candidateInvolvement: boolean
    
    Flag indicating if the candidate will be involved in the case
  - candidateLastName: string
    
    Candidate's last (family) name
  - Optional candidatePID?: number
    
    Candidate's Interfolio PID
  - packetTypeId: number
    
    Packet Type ID of the case (e.g. Appointment/Promotion etc)
  - unitId: number
    
    Unit id of the case
Returns Promise<Packet>

createFromTemplate

createFromTemplate(__namedParameters: CreatePacketFromTemplateParams): Promise<PacketDetail>

Create a new Case from a case template

example

let case = await api.Tenure.Packets.createFromTemplate({
  packetId: 9999,
  unitId: 9999,
  candidateFirstName: "Holly",
  candidateLastName: "Doe",
  candidateEmail: "holly.doe@example.com"
  candidateInvolvement: false
});

Parameters

__namedParameters: CreatePacketFromTemplateParams

Returns Promise<PacketDetail>

delete

delete(__namedParameters: { id: number }): Promise<boolean>

- Defined in tenure/packet-api.ts:492
Delete the case (note: can only be performed when API user has root unit admin permissions)
example
```
await api.Tenure.Packets.delete({id: 9999});
```
Parameters
- __namedParameters: { id: number }
  - id: number
Returns Promise<boolean>

getPacket

getPacket(__namedParameters: { id: number }): Promise<PacketDetail>

- Defined in tenure/packet-api.ts:512
Get the packet detail information
example
```
let packet = await api.Tenure.Packets.getPacket({id: 9999});
```
Parameters
- __namedParameters: { id: number }
  - id: number
    
    Id of the packet
Returns Promise<PacketDetail>

moveBackward

moveBackward(__namedParameters: MoveParams): Promise<PacketDetail>

Send the case forward to the next workflow step

example

await api.Tenure.Packets.moveBackward({id: 9999, sendNotification: false"});
await api.Tenure.Packets.moveBackward({id: 9999,
  sendNotifcation: true,
  selectedCommitteeId: 9999,
  notificationSubject:"Returned Case",
  notificationBody:"Case Returned for Corrections"
});

Parameters

__namedParameters: MoveParams

Returns Promise<PacketDetail>

moveForward

moveForward(__namedParameters: MoveParams): Promise<PacketDetail>

Send the case forward to the next workflow step

example

await api.Tenure.Packets.moveForward({id: 9999, sendNotification: false"});
await api.Tenure.Packets.moveForward({
  id: 9999,
  sendNotifcation: true,
  selectedCommitteeId: 9999,
  notificationSubject:"Review Case",
  notificationBody:"Here is a case to review"
});

Parameters

__namedParameters: MoveParams

Returns Promise<PacketDetail>

Static removePacketDetailNesting

removePacketDetailNesting<T>(apiResponse: ApiResponse): T

- Defined in tenure/packet-api.ts:639
Remove the cumbersome second level for various nested values

Type parameters
- T
Parameters
- apiResponse: ApiResponse
  
  The response from the API to remove the nesting from
Returns T

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: ApiRequest | ApiConfig

Returns PacketApi

Properties

EvaluatorSections

PlatformForms

WorkflowSteps

Readonly apiRequest

Methods

archive

Parameters

__namedParameters: { packetId: number; statusId: number }

packetId: number

statusId: number

Returns Promise<boolean>

create

Parameters

__namedParameters: { candidateEmail: string; candidateFirstName: string; candidateInvolvement: boolean; candidateLastName: string; candidatePID?: number; packetTypeId: number; unitId: number }

candidateEmail: string

candidateFirstName: string

candidateInvolvement: boolean

candidateLastName: string

Optional candidatePID?: number

packetTypeId: number

unitId: number

Returns Promise<Packet>

createFromTemplate

Parameters

__namedParameters: CreatePacketFromTemplateParams

Returns Promise<PacketDetail>

delete

Parameters

__namedParameters: { id: number }

id: number

Returns Promise<boolean>

getPacket

Parameters

__namedParameters: { id: number }

id: number

Returns Promise<PacketDetail>

moveBackward

Parameters

__namedParameters: MoveParams

Returns Promise<PacketDetail>

moveForward

Parameters

__namedParameters: MoveParams

Returns Promise<PacketDetail>

Static removePacketDetailNesting

Type parameters

T

Parameters

apiResponse: ApiResponse

Returns T