PacketTemplateApi | Interfolio API

Class representing the an RPT Case Template

Hierarchy

PacketTemplateApi

Index

Constructors

constructor

Properties

apiRequest

Methods

Constructors

constructor

new PacketTemplateApi(config: ApiRequest | ApiConfig): PacketTemplateApi

- Defined in tenure/packet-template-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 PacketTemplateApi

Properties

Readonly apiRequest

apiRequest: ApiRequest

API request object for making the actual http requests

Methods

create

create(__namedParameters: { description: string; name: string; packetTypeId: number; unitId: number }): Promise<Packet>

- Defined in tenure/packet-template-api.ts:50
Create a new case template
example
```
let template = await api.Tenure.PacketTemplates.create({unitId: 9999, name: "Template Name", packetTypeId: 1});
```
Parameters
- __namedParameters: { description: string; name: string; packetTypeId: number; unitId: number }
  - description: string
    
    Description of the template
  - name: string
    
    Name of the Template
  - packetTypeId: number
    
    Id of the packet type (e.g. Appointment/Reappointment etc).
  - unitId: number
    
    Unit ID of the template
Returns Promise<Packet>

delete

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

- Defined in tenure/packet-template-api.ts:87
Delete a packet template
example
```
let deleteSuccess = await api.Tenure.PacketTemplates.delete({id: 9999});
```
Parameters
- __namedParameters: { id: number }
  - id: number
    
    Id of the packet template to delete
Returns Promise<boolean>

findUnitTemplate

findUnitTemplate(__namedParameters: { name: string; unitId: number }): Promise<PacketTemplateDetail>

- Defined in tenure/packet-template-api.ts:105
Find a unit template

Parameters
- __namedParameters: { name: string; unitId: number }
  - name: string
  - unitId: number
Returns Promise<PacketTemplateDetail>

getTemplate

getTemplate(__namedParameters: { id: number }): Promise<PacketTemplateDetail>

- Defined in tenure/packet-template-api.ts:143
Get the template
example
```
let template = await api.Tenure.PacketTemplates.getTemplate({id: 9999});
```
Parameters
- __namedParameters: { id: number }
  - id: number
    
    ID of the template
Returns Promise<PacketTemplateDetail>

Generated using TypeDoc